An API creator blocks subscription to an API as a way of disabling access to it and managing its usage and monetization. A blocking can be temporary or permanent. There is an unblocking facility to allow API invocations back.
You block APIs by subscriptions. That is, a given user is blocked access to a given API subscribed to using a given application. If a user is subscribed to two APIs using the same application and you block access to only one of the APIs, s/he can still continue to invoke the other APIs that s/he subscribed to using the same application. Also, s/he can continue to access the same API subscribed to using different applications.
Blocking can be done in two levels:
- Block production and sandbox access: API access is blocked with both production and sandbox keys
- Block production access only: Allows sandbox access only. Useful when you wants to fix and test an issue in an API. Rather than blocking all access, you can block production access only, allowing the developer to fix and test.
When API Gateway caching is enabled (it is enabled by default), even after blocking a subscription, consumers might still be able to access APIs until the cache expires, which happens approximately every 15 minutes.
- Log in to the API Publisher.
- Create two APIs by the names
TestAPI2and publish them to the API Store.
- Log in to the API Store. Click the APIs menu and note that the two APIs are visible in the APIs page.
- Subscribe to both APIs using the same application. You can use the default application or create your own.
- Go to the My Subscriptions page and create an access token to the default application.
Invoke both APIs using the access token you got in the previous step. We use cURL here. The command is,
Be sure to replace the placeholders as follows:
- <access token>: Give the token generated in step 5
<API URL>: Go to the API's Overview tab in the API Store and copy the production URL and append the payload to it.
Here's an example:
You have subscribed to two APIs and invoked them successfully. Let's block one subscription and see the outcome.
- Log back to the API Publisher.
- Click the Subscriptions menu to open the Subscriptions page. It shows all APIs/applications that each user is subscribed to.
- Block subscription for
DefaultApplication. Select the
production and sandboxoption and click the Block link.
- Note that the Block link immediately turns to Unblock, allowing you to activate the subscription back at any time.
- Log back to the API Store.
Invoke the two APIs (
You might have to regenerate the access token for
DefaultApplicationif the access token expiration time (1 hour by default) has passed since the last time you generated it. You can refresh the access token by going to the My Subscriptions page in the Store.
- Note that you can invoke
TestAPI2again but when you invoke
TestAPI1, it gives a message that the requested API is temporarily blocked. Neither the API creator nor any subscriber can invoke the API until the block is removed.
- Go to the My Subscriptions page in the API Store, select the application that you used to subscribe to the API and note that your subscription is blocked.
- Go back to the API Publisher's Subscriptions page and unblock the subscription.
TestAPI1again and note that you can invoke it as usual.
You have subscribed to two APIs, blocked subscription to one and tested that you cannot invoke the blocked API.