Where to put API Key using retrofit in Android Studio

Question

I am creating a News app using api key from newsapi.org This is my code for Interface which i have created using tutorial found on https://www.learn2crack.com/2016/02/recyclerview-json-parsing.html.I am confused what is the syntax and where to put api key in this interface.

public interface RequestInterface {

@GET("android/jsonandroid")
Call<JSONResponse> getJSON();}

and this is my code for MainActivity.java

public class MainActivity extends AppCompatActivity {
    private RecyclerView recyclerView;
    private ArrayList<Article> data;
    private DataAdapter adapter;


    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        initViews();
    }
    private void initViews(){
        recyclerView = (RecyclerView)findViewById(R.id.card_recycler_view);
        recyclerView.setHasFixedSize(true);
        RecyclerView.LayoutManager layoutManager = new LinearLayoutManager(getApplicationContext());
        recyclerView.setLayoutManager(layoutManager);
        loadJSON();
    }
    private void loadJSON(){
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("BASE_URL")
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        RequestInterface request = retrofit.create(RequestInterface.class);
        Call<JSONResponse> call = request.getJSON();
       call.enqueue(new Callback<JSONResponse>() {
           @Override
           public void onResponse(Call<JSONResponse> call, Response<JSONResponse> response) {
               JSONResponse jsonResponse = response.body();
               data = new ArrayList<>(Arrays.asList(jsonResponse.getAndroid()));
               adapter = new DataAdapter(data);
               recyclerView.setAdapter(adapter);
           }

           @Override
           public void onFailure(Call<JSONResponse> call, Throwable t) {
               Log.d("Error",t.getMessage());
           }
       });
    }
}

Answer 1

Use @Headers for one request:

@Headers("api-key: " + "PUT_YOUR_API_KEY")
@GET("android/jsonandroid")
Call<JSONResponse> getJSON();
}

and use addInterceptor in OkHttpClient.Builder for all requests:

OkHttpClient.Builder builder = new OkHttpClient.Builder();

builder.addInterceptor(new Interceptor() {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request().newBuilder().addHeader("api-key", "PUT_YOUR_API_KEY").build();
            return chain.proceed(request);
    }
});

Answer 2

For newsapi.org, suppose your source is mashable try this

public interface RequestInterface {
@GET("v1/articles?source=mashable&sortBy=top&apiKey=your_apikey_here")
Call<JSONResponse> getJSON();
}

and this should be baseurl

Retrofit retrofit = new Retrofit.Builder()

            .baseUrl("https://newsapi.org/")
            .addConverterFactory(GsonConverterFactory.create())
            .build();

Answer 3

To answer the "where" question, from my understanding, it depends on the API you're calling. You may put it in header or as a query for instance.

The good way to do it if you need to use the key for every calls is to add an Interceptor.

private fun apiKeyAsQuery(chain: Interceptor.Chain) = chain.proceed(
        chain.request()
            .newBuilder()
            .url(chain.request().url.newBuilder().addQueryParameter("api-key", ApiKey).build())
            .build()
    )

private fun apiKeyAsHeader(it: Interceptor.Chain) = it.proceed(
    it.request()
        .newBuilder()
        .addHeader("api-key", ApiKey)
        .build()
)

...
.client(
    OkHttpClient.Builder()
        .addInterceptor { apiKeyAsQuery(it) }
        // Or
        .addInterceptor { apiKeyAsHeader(it) }
        .build()
)
...