Basic Authentication in Retrofit android

Aman Gupta

1 August 2017

Retrofit is a library which is type-safe REST client for Android. Type-safe means that the compiler will validate types while compiling, and throw an error if you try to assign the wrong type to a variable.

Before Reading this blog you have to read following blog to learn the basic knowledge of the Retrofit,

Using Retrofit library to make Http Requests

How to add Basic Authentication

Step 1: Make an interface,

public interface ApiInterface { String MOBIKUL_HOME_PAGE_DATA = "api/homepage/{customerId}"; @GET(MOBIKUL_HOME_PAGE_DATA) Call<HomepageData> getHomePageData( @Header("Authorization") String authkey , @Path("customerId") String customerId ); }

1
2
3
4
5
6
7
8
9
10
11

public interface ApiInterface {

    String MOBIKUL_HOME_PAGE_DATA = "api/homepage/{customerId}";

@GET(MOBIKUL_HOME_PAGE_DATA)
    Call<HomepageData> getHomePageData(
            @Header("Authorization") String authkey
            , @Path("customerId") String customerId
    );

}

Step 2: Create the AuthToken

public static String getAuthToken() { byte[] data = new byte[0]; try { data = (ApplicationConstant.API_USER_NAME + ":" + ApplicationConstant.API_PASSWORD).getBytes("UTF-8"); } catch (UnsupportedEncodingException e) { e.printStackTrace(); } return "Basic " + Base64.encodeToString(data, Base64.NO_WRAP); }

1
2
3
4
5
6
7
8
9

public static String getAuthToken() {
        byte[] data = new byte[0];
        try {
            data = (ApplicationConstant.API_USER_NAME + ":" + ApplicationConstant.API_PASSWORD).getBytes("UTF-8");
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
        return "Basic " + Base64.encodeToString(data, Base64.NO_WRAP);
    }

Step 3: Create the Retrofit Client,

public class RetrofitClient { private static Retrofit retrofit = null; public static Retrofit getClient(Context mContext) { if (retrofit == null) { retrofit = new Retrofit.Builder() .baseUrl(BASE_URL) .addConverterFactory(GsonConverterFactory.create()) .build(); } return retrofit; } }

1
2
3
4
5
6
7
8
9
10
11
12
13
14

public class RetrofitClient {
    private static Retrofit retrofit = null;

    public static Retrofit getClient(Context mContext) {
        if (retrofit == null) {

            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
    }
}

Step 4: Make your call,

public static void getHomePage(Context mContext, Callback<HomepageData> callback) { Call<HomepageData> call = RetrofitClient.getClient(mContext).create(ApiInterface.class).getHomePageData( Helper.getAuthToken() , AppSharedPref.getCustomerId(mContext) ); call.enqueue(callback); }

1
2
3
4
5
6
7

public static void getHomePage(Context mContext, Callback<HomepageData> callback) {
        Call<HomepageData> call = RetrofitClient.getClient(mContext).create(ApiInterface.class).getHomePageData(
                Helper.getAuthToken()
                , AppSharedPref.getCustomerId(mContext)
        );
        call.enqueue(callback);
    }

call the Api with Basic Authorization,

RetrofitCalls.getHomePage(Activity.this, callback);

1

RetrofitCalls.getHomePage(Activity.this, callback);

Thanks for reading this blog, You have any questions or problems comment below.

Happy Coding. Stay Super.