Interceptor addition (ssd api-management add api-interceptor)

The ssd api-management add (plan | api)-interceptor command allows you to add an interceptor to an API or plan flow on Sensedia API Platform.

You can use the ssd api-management add (plan | api)-interceptor command or its shortened version ssd apim add (plan | api)-interceptor.

Usage

The ssd api-management add (plan | api)-interceptor command requires a subcommand, corresponding to the interceptor you want to add:

ssd api-management add (plan | api)-interceptor [command]

Below you will find a usage example:

# Adds a Log interceptor to the API or plan inbound flow for all of its resources and methods
$ ssd (api-management | apim) add api-interceptor log --api-name "Open Banking" --api-version 1.0.0 --flow INBOUND --revision 1
$ ssd (api-management | apim) add plan-interceptor log --plan-name "Plan Name" --flow INBOUND

# The position of the interceptor in the flow can be specified using the `--position` flag (if this flag is omitted, the interceptor's position in the flow will be the last one):
$ ssd (api-management | apim) add api-interceptor log --api-name "Open Banking" --api-version 1.0.0 --flow INBOUND --revision 1 --position 2
$ ssd (api-management | apim) add plan-interceptor log --plan-name "Plan Name" --flow INBOUND --position 2

# Adds the interceptor to a specific resource, method and path
$ ssd (api-management | apim) add api-interceptor log --api-name "Open Banking" --api-version 1.0.0 --flow INBOUND --revision 1 --position 2 --resource "consent" --method "POST" --path "/consent/allow"
$ ssd (api-management | apim) add plan-interceptor log --plan-name "Plan Name" --flow INBOUND --position 2 --resource "consent"

# As the command below shows, you can build combinations with resource, method and path
$ ssd (api-management | apim) add plan-interceptor log --plan-name "Plan Name" --flow INBOUND --position 2 --resource "consent" --method "POST" --path "/consent/allow"
$ ssd (api-management | apim) add api-interceptor log --api-name "Open Banking" --api-version "1.0.0" --revision 1 --flow INBOUND --position 2 --resource "consent" --method "POST" --path "/consent/allow"

Available subcommands

The following subcommands can be used with the ssd api-management add (plan | api)-interceptor command (read more about them by clicking on the corresponding links):

  • header: Adds a "Header" interceptor to an API or plan flow on Sensedia API Platform;

  • http-method: Adds an "HTTP Method" interceptor to an API or plan flow on Sensedia API Platform;

  • json-txt: Adds a "JSON to TXT" interceptor to an API or plan flow on Sensedia API Platform;

  • json-xml: Adds a "JSON to XML" interceptor to an API or plan flow on Sensedia API Platform;

  • ip-filtering: Adds an "IP Filtering" interceptor to an API or plan flow on Sensedia API Platform;

  • log: Adds a "Log" interceptor to an API or plan flow on Sensedia API Platform;

  • log-obfuscation: adds a "Log Obfuscation" interceptor to an API or plan flow on Sensedia API Platform;

  • oauth: Adds an "OAuth" interceptor to an API or plan flow on Sensedia API Platform;

  • rate-limit: Adds a "Rate Limit" interceptor to an API or plan flow on Sensedia API Platform;

  • restrict: Adds a "Restrict Access" interceptor to an API or plan flow on Sensedia API Platform;

  • spike-arrest: Adds a "Spike Arrest" interceptor to an API or plan flow on Sensedia API Platform;

  • txt-json: Adds a "TXT to JSON" interceptor to an API or plan flow on Sensedia API Platform;

  • xml-json: Adds an "XML to JSON" interceptor to an API or plan flow on Sensedia API Platform.

Thanks for your feedback!
EDIT

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