An access token is a simple string that is passed as an HTTP header of a request. For example, "
Authorization: Bearer NtBQkXoKElu0H1a1fQ0DWfo6IX4a." Access tokens authenticate API users and applications, and ensure better security (e.g., prevent DoS attacks). If a token that is passed with a request is invalid, the request is discarded in the first stage of processing. Access tokens work equally well for SOAP and REST calls.
There are two types of access tokens:
- Application Access Tokens : Tokens to authenticate an application, which is a logical collection of APIs. You to access all APIs associated with an application using a single token, and also subscribe multiple times to a single API with different SLA levels. Application access tokens leverage OAuth2 to provide simple key management.
- User Access Tokens : Tokens to authenticate the final user of an API. User access tokens allow users to invoke an API even from a third-party application like a mobile app.
The sections below show how to generate and renew each type of access token:
- Generating application access tokens
- Restricting access to specific domains
- Generating user access tokens
- Renewing application access tokens
- Renewing user access tokens
Generating application access tokens
The steps below describe how to generate application access tokens:
- Log in to the API Store.
Click My Subscriptions from the menu bar at the top of the screen. The Subscriptions page opens, using which you can generate a production key and/or a sandbox key for testing purpose.
The two inputs mean the following:
The domains from which requests are allowed to the APIs. Leave empty or enter "ALL" to allow all domains.
Whenever an API call happens, the Gateway checks if the request originated from an allowed domain and grants access accordingly. This ensures that clients from a restricted domain cannot access an API even if an application key is stolen (when the key is placed in client-side JS code).
When the client makes a request to an API that is only allowed to some domains, the request message must have an HTTP header to specify its domain name. Sending this header is mandatory only if the API is restricted to certain domains. An admin can configure this header name using in
<APIM_HOME>/repository/conf/api-manager.xml. For example, if the file contains
<ClientDomainHeader>domain</ClientDomainHeader>, then the API invocation request must contain an HTTP header called
domainwith values as shown in the example below:
curl -v -H "Authorization: Bearer xxx" -H "domain: wso2.com" http://localhost:8280/twitter/1.0.0/search.atom?q=cat
Token ValidityText Area The period after which the token will be expired after generation. A negative value ensures that the token will never expire.
Renewing application access tokens
When an application access token expires, you renew it by logging into the API Store, selecting the My Subscriptions menu and and clicking Re-generate.