Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
bgColor#d3d3d3

In this tutorial, you block subscription to an API in the API Publisher and observe how the subscribers can interact with it in the API Store. You also observe how the subscriber experience changes when you unblock the API again.

 

Note

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.

...

Note

See the following topics for a description of the concepts that you need to know when you block subscriptions to an API:

Applications

Throttling 

 

...

Let's get started. See the video tutorial here or a step-by-step walk-through of the video tutorial below. 

...