API authentication

View as Markdown

All API requests need to be authenticated through the Authorization header. The Infobip API offers the following authentication methods:

HTTP Basic authentication
API keys
IBSSO tokens
OAuth 2.0

Select your preferred method to suit your current tech stack and security requirement level. Many of these methods are vulnerable to man-in-the-middle attacks, so it is recommended to combine them with other security mechanisms such as an encrypted connection or SSL.

Refer to the Errors section to troubleshoot potential issues, or alternatively reach out to the Infobip Support team for help.

Basic

Basic authentication works by sending a username and password in every API request. Typically, this method is used in situations when the API key is not available. For example, API methods generating API keys could be authenticated with Basic.

Basic Auth is the least recommended method as it is still simple to decode encrypted credentials back to their original values. Refer to the HTTP Authentication resource to see how to restrict access to your server with Basic authentication.

Here are some key facts about this method:

Built into HTTP protocol itself
Credentials should be encoded in a Base64 format (for example, with the RFC2045-MIME variant) and separated by a colon (:)
Encoded credentials are added to the header after Basic

Example - HTTP client

When using any of the Infobip API client libraries you don't have to manually encode the credentials. You only need to specify the username and password when creating an instance of a client object.

REQUEST SAMPLES

curl

2 curl -L -g -X GET 'https://{baseUrl}/sms/2/text/advanced' /

3 -H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='

Example - API client library

When using any of the Infobip API client libraries you do not have to manually encode the credentials data like mentioned above. You only need to specify the username and password when creating an instance of a client object as shown in the example below.

csharp

2 var configuration = new Configuration()

3 {

4 BasePath = "BASE_URL",

5 Username = "USERNAME",

6 Password = "PASSWORD"

7 };

API scopes on Basic Auth [#api-scopes-on-basic-auth-basic]

For information on API scopes associated with Basic Auth, refer to the dedicated User roles and API scopes section.

API key header

An API key is an access token that a client provides when making API calls. It is a simple way to secure access and thus the most popular authentication method used with REST APIs.The key can be sent in the query string or as a request header. You are automatically assigned an API Key once you create an account. Generate more keys and manage the existing ones through the Infobip API key management page.

Here are some key facts about this method:

API keys can be generated by calling the dedicated API method
Keys can be revoked at any time which is useful when separating the API access rights across multiple applications or use cases
Infobip API keys have a predefined expiry date to eventually become invalid

Example - HTTP client

The examples below show how to specify the API Key authentication when using client libraries.

REQUEST SAMPLES

curl

2 curl -L -g -X GET 'https://{baseUrl}/sms/2/text/advanced' /

3 -H 'Authorization: App 003026abc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9'

Example - API client library

The examples below show how to prepare an HTTP request using API Key authentication. Note this request is much simpler than using a basic authentication request.

REQUEST SAMPLES

java

2 ApiClient apiClient = ApiClient.forApiKey(ApiKey.from(API_KEY))

3 .withBaseUrl(BaseUrl.from(BASE_URL))

4 .build();

API scopes on API keys [#api-scopes-on-api-keys-api-key-header]

For details on API scopes, see the dedicated API scopes section.

IBSSO token header

IBSSO tokens are session-based meaning tokens are valid for a short amount of time. That ultimately makes this method more secure, but also requires more maintenance to keep authentication valid.

Typically, this kind of authentication is used in single sign-on scenarios where multiple sign-ins which to be avoided across the system. It may be also useful in scenarios when sensitive data needs to be handled centrally without the need to distribute it across various enterprise systems.

Here are some key facts about this method:

All API requests are authenticated with a session token
By default, IBSSO tokens will expire after 60 minutes after which a new token must be created
If you want to create a new token but the previous one has not expired yet, you will first need to destroy the session
You can shorten the session's length with a dedicated API call

How to use IBSSO tokens [#how-to-use-ibsso-tokens-ibsso-token-header]

Make a call to create a session endpoint and take the token from the response.
Include IBSSO and the token in the Authorization header for all subsequent calls: Authorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394
Optionally, destroy the session to adjust the session's length to your needs. By default, the session will expire after 60 minutes.

HTTP request [#http-request-ibsso-token-header]

Obtain IBSSO token [#obtain-ibsso-token-ibsso-token-header]

Create a session by calling the Create session endpoint. The response will contain the token which can then be used in the HTTP header of the requests to other API endpoints such as Send SMS.

REQUEST SAMPLES

java

2 private static class IbssoResponse {

3 public IbssoResponse() {

4 super();

5 }

7 @JsonProperty("token")

8 public String token;

10 @JsonGetter("token")

11 public String getToken() {

12 return token;

13 }

15 @JsonSetter("token")

16 public void setToken(String token) {

17 this.token = token;

18 }

19 }

21 String jsonBody = String.format("{\"username\":\"%s\",\"password\":\"%s\"}", "USERNAME", "PASSWORD");

23 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), jsonBody);

25 Request request = new Request.Builder()

26 .url("BASE_URL" + "/auth/1/session")

27 .addHeader("Content-Type", "application/json")

28 .addHeader("Accept", "application/json")

29 .post(requestBody)

30 .build();

32 OkHttpClient httpClient = new OkHttpClient().newBuilder().build();

33 Response response = httpClient.newCall(request).execute();

34 String responseBody = response.body().string();

35 System.out.println(responseBody);

37 IbssoResponse ibssoResponse = new ObjectMapper().readValue(responseBody, IbssoResponse.class);

39 return ibssoResponse.token;

Example - HTTP client

The examples below show how to prepare the HTTP request. Note that this is almost identical to API Key authentication, but instead of App, you will use IBBSOin the header.

REQUEST SAMPLES

java

2 private static class IbssoResponse {

3 public IbssoResponse() {

4 super();

5 }

7 @JsonProperty("token")

8 public String token;

10 @JsonGetter("token")

11 public String getToken() {

12 return token;

13 }

15 @JsonSetter("token")

16 public void setToken(String token) {

17 this.token = token;

18 }

19 }

21 String jsonBody = String.format("{\"username\":\"%s\",\"password\":\"%s\"}", "USERNAME", "PASSWORD");

23 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), jsonBody);

25 Request request = new Request.Builder()

26 .url("BASE_URL" + "/auth/1/session")

27 .addHeader("Content-Type", "application/json")

28 .addHeader("Accept", "application/json")

29 .post(requestBody)

30 .build();

32 OkHttpClient httpClient = new OkHttpClient().newBuilder().build();

33 Response response = httpClient.newCall(request).execute();

34 String responseBody = response.body().string();

35 System.out.println(responseBody);

37 IbssoResponse ibssoResponse = new ObjectMapper().readValue(responseBody, IbssoResponse.class);

39 return ibssoResponse.token;

Example - API library

When using any of the Infobip API client libraries, you will need the same elements that you would for the API Key authentication, but instead of App, you will use IBBSO.

csharp

2 var configuration = new Configuration()

3 {

4 BasePath = "BASE_URL",

5 ApiKeyPrefix = "IBSSO",

6 ApiKey = "TOKEN"

7 };

OAuth 2.0

This type of authentication is the most secure option and is almost industry standard. Similar to using IBSSO tokens, you will use an access token you get from separate endpoint.

Here are some key facts about this method:

The access token returned in response will expire within the time limit provided in seconds in the same response.
Infobip acts as both a resource and an authorization server.
A new token has to be created once the token expires. There is no automatic token retrieval.

For more details, see the official OAuth 2.0 specification.

How to use OAuth 2.0 [#how-to-use-oauth-20-oauth-20]

Make a call to get the access token and the expiration time from a separate endpoint.
Include Bearer and the token in the Authorization header for all subsequent calls until the token expires. Authorization: Bearer eyJraWQiOiI5d29rWGRoSSIsInR5cCI6IkpXVCIsImFsZyI6IkhTMjU2In0.eyJzdWIiOiJERDIwMjAiLCJpc3MiOiJpbmZvYmlwLmNvbSIsImV4cCI6MTYzMzAwNDQwNiwiaWF0IjoxNjMzMDAwODA2LCJqdGkiOiJiMmJmODgyMS01OTcxLTRiOTMtYWVmNy0zM2QwMDNkMjIxNjcifQ.KvIIOmCKJETiB6xKOqBxvZYnYOa8RAulYhChBEmI4Os

HTTP request [#http-request-oauth-20]

Create OAuth2 token

Obtain OAuth token [#obtain-oauth-token-oauth-20]

Similarly to IBSSO tokens, you have to first obtain a token before making any API calls.

REQUEST SAMPLES

java

2 private static class OauthResponse {

3 public OauthResponse() {

4 super();

5 }

7 @JsonProperty("access_token")

8 private String accessToken;

9 @JsonProperty("expires_in")

10 private String expiresIn;

12 @JsonGetter("access_token")

13 public String getAccessToken() {

14 return accessToken;

15 }

17 @JsonSetter("access_token")

18 public void setAccessToken(String accessToken) {

19 this.accessToken = accessToken;

20 }

22 @JsonGetter("expires_in")

23 public String getExpiresIn() {

24 return expiresIn;

25 }

27 @JsonSetter("expires_in")

28 public void setExpiresIn(String expiresIn) {

29 this.expiresIn = expiresIn;

30 }

31 }

33 HttpPost post = new HttpPost(BASE_URL + "/auth/1/oauth2/token");

34 List nvps = new ArrayList();

35 nvps.add(new BasicNameValuePair("client_id", username));

36 nvps.add(new BasicNameValuePair("client_secret", password));

37 nvps.add(new BasicNameValuePair("grant_type", "client_credentials"));

39 post.setEntity(new UrlEncodedFormEntity(nvps, HTTP.UTF_8));

41 DefaultHttpClient httpClient = new DefaultHttpClient();

42 HttpResponse response = httpClient.execute(post);

43 System.out.println(response.getStatusLine());

45 String responseJson = EntityUtils.toString(response.getEntity());

46 System.out.println(responseJson);

48 OauthResponse oauthResponse = new ObjectMapper().readValue(responseJson, OauthResponse.class);

50 return oauthResponse.accessToken;

Example - HTTP client

The examples below show how to prepare an HTTP client request with a header.

REQUEST SAMPLES

java

2 Request request = new Request.Builder()

3 .url("BASE_URL" + "/sms/2/text/advanced")

4 .addHeader("Authorization", "Bearer " + accessToken)

5 .addHeader("Content-Type", "application/json")

6 .addHeader("Accept", "application/json")

7 .post(body)

8 .build();

Example - API library

The examples below show how to prepare an HTTP request with headers.

csharp

2 var configuration = new Configuration()

3 {

4 BasePath = "BASE_URL",

5 ApiKeyPrefix = "Bearer",

6 ApiKey = "ACCESS_TOKEN"

7 };

Errors

Commonly you will get the 401 Unauthorised HTTP status code in response when there is a missing or invalid username or password.

json

2 {

3 "requestError": {

4 "serviceException": {

5 "messageId": "UNAUTHORIZED",

6 "text": "Invalid login details"

7 }

8 }

9 }

Library exceptions [#library-exceptions-errors]

When using one of the libraries, make sure to handle API exceptions.

REQUEST SAMPLES

java

2 try {

3 SmsResponse smsResponse = sendSmsApi.sendSmsMessage(smsMessageRequest);

4 } catch (ApiException apiException) {

5 apiException.getCode();

6 apiException.getResponseHeaders();

7 apiException.getResponseBody();

8 }