What are interceptors, what are they for and how do I configure them?

What are interceptors?

An interceptor is a component that literally intercepts the API flow and applies policies to it.

What are they for?

The interceptor modifies the API request or response by transforming, obfuscating, encrypting data, etc.


For more details on its definition and operation, see the interceptors page from our user guide.

How to configure them

Simply drag and drop and, in some cases, configure the desired interceptor:

  1. Access the API Catalog from the side API Design > API Catalog.

  2. Click the card or line that has the API you want. If necessary, use the search fields and click SEARCH.

  3. Check the name of the API, scroll until you find the section named Flows and click the EDIT button.
    detail of API overview screen

  4. Navigate the tabs and locate the desired interceptor.

  5. Click and drag the interceptor into the flow.
    Some interceptors are specific to the request flow, others to the response flow and some can be used for both. See more details on each interceptor on the interceptors page in the user guide.

    animation showing how to add an interceptor to the flow

  6. Interceptors are configurable. Simply fill in the information on the screen that opens after you drop the interceptor into the flow.

  7. When you are finished entering the information, click SAVE.

  8. Repeat steps 5 to 7 until you have configured all the interceptors you want. When you are done, click CONTINUE.

  9. Click on SAVE or SAVE AS NEW REVISION to save the revision.
    screen detail showing the buttons to save the revision

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]