This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Subscribe to an API

Before using a published API in your applications, you first subscribe to it. Subscription enables you to receive access tokens and be authenticated to invoke the API and also select a level of usage (usually for monetization purpose).

Follow the instructions below to subscribe to an API.

  1. Log in to the API Store.
    In a multi tenant environment such as the API Cloud, you can view the stores of all tenants registered in the system
    . If you know the name of the tenant, you can access it using the URL http://<hostname>/Store?tenant=<tenant_name>.
  2. Find an API to subscribe to. You can use the search facility, tags, forums, documentation etc. to help select an API.
  3. Click on the API and see the subscription options.

    ApplicationsAn application is a logical collection of one or more APIs and is required to subscribe to an API. Applications allow you to use a single access token to invoke a collection of APIs and to subscribe to one API multiple times with different SLA levels.
    Tiers

    Depending on the tier you select, you can make a maximum number of requests to an API per minute. The default throttling levels are are as follows:

    • Bronze : 1 request per minute
    • Silver : 5 requests per minute
    • Gold : 20 requests per minute
    • Unlimited : Unlimited access

    Note that the example above has two URLs for for production and sandbox each. This is because the API is marked as a default API.

  4. Select an application from the Applications drop-down list. You can use the default application or create a new one.
  5. Click the My Applications menu and create a new application.


  6. Subscribe to the API using the new application.
  7. If the subscription is successful, a message appears. Select Go to My Subscriptions. You will be navigated to a page where you can create access tokens to your application/s.