PingIntelligence

Configuring tags in API Manager

About this task

Tags are a medium to let ASE know which APIs from the API ecosystem need to be processed for monitoring and attack detection. Tags are also required for cookie and login Uniform Resource Locator (URL) parameters to be captured by the PingIntelligence Dashboard for adding to the ASE API JavaScript Object Notation (JSON) definition.

To tag APIs for artificial intelligence (AI) processing:

Steps

  1. Configure the ping_ai tag for all the APIs for which you want the traffic to be processed using the AI engine.

    For example, if you have 10 APIs in your ecosystem and you want only traffic for 5 APIs to be processed using the AI engine, then apply the ping_ai tag on those 5 APIs.

    1. In the Axway API Manager, click Frontend API → API tab. In the API tab, navigate to the Tags section and add the following tag and value:

      • ping_ai – Set it to true if you want the traffic for API to be processed by PingIntelligence

      • ping_blocking – This parameter defines whether enable_blocking in the ASE API JSON is set to true or false when the PingIntelligence Dashboard fetches the API definition from Axway. The default value is true. If you want to disable blocking in ASE, set it to false.

  2. If your APIs use a cookie or login URL, then configure the following two tags and values for a cookie and login URL.

    1. In the Axway API Manager, go to Frontend API → API tab. In the API tab, navigate to Tags section and add the following tag and value:

      • ping_cookie – JSESSIONID

      • ping_login – yourAPI/login

        If the API has API Key or OAuth2 token configured, the PingIntelligence Dashboard automatically learns it and adds it to the API JSON definition. You do not need to configure any tags for API Key and OAuth2 token.
    A screen capture of the API tab on the Viewing API page in Axway API Manager.