Work with the Capping API

The Capping API helps you create, configure and monitor your capping configurations.

This section provides global information on how to work with the API. A detailed API description is available in Adobe Journey Optimizer APIs documentation.

Capping API description & Postman collection

The table below lists the available commands for the capping API. Detailed information including request samples, parameters, and response formats is available in the Adobe Journey Optimizer APIs documentation.

When a configuration is created or updated, a check is automatically performed to guarantee the syntax and the integrity of the payload.
If some problems occur, the operation returns warning or errors to help you correct the configuration.

In addition, a Postman collection is available here to help you in your testing configuration.

This collection has been set up to share the Postman Variable collection generated via Adobe I/O Console’s Integrations > Try it out > Download for Postman, which generates a Postman Environment file with the selected integrations values.

Once downloaded and uploaded into Postman, you need to add three variables: {JO_HOST},{BASE_PATH} and {SANDBOX_NAME}.

• {JO_HOST} : Journey Optimizer Gateway URL.
• {BASE_PATH} : entry point for the API.
• {SANDBOX_NAME} : the header x-sandbox-name (for example, ‘prod’) corresponding to the sandbox name where the API operations will take place. See the sandboxes overview for more information.

Endpoint configuration

Here is the basic structure of an endpoint configuration:

{
    "url": "<endpoint URL>",  //wildcards are allowed in the endpoint URL
    "methods": [ "<HTTP method such as GET, POST, >, ...],
    "services": {
        "<service name>": { . //must be "action" or "dataSource"
            "maxHttpConnections": <max connections count to the endpoint (optional)>
            "rating": {
                "maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
                "periodInMs": <integer value greater than 0>
            }
        },
        ...
    }
}

Example:

`{
  "url": "https://api.example.org/data/2.5/*",
  "methods": [
    "GET"
  ],
  "services": {
    "dataSource": {
      "rating": {
        "maxCallsCount": 500,
        "periodInMs": 1000
      }
    }
  }
}

Warning and errors

When a canDeploy method is called, the process validates the configuration and returns the validation status identified by its Unique ID, either:

"ok" or "error"

The potential errors are:

• ERR_ENDPOINTCONFIG_100: capping config: missing or invalid url
• ERR_ENDPOINTCONFIG_101: capping config: malformed url
• ERR_ENDPOINTCONFIG_102: capping config: malformed url: wildchar in url not allowed in host:port
• ERR_ENDPOINTCONFIG_103: capping config: missing HTTP methods
• ERR_ENDPOINTCONFIG_104: capping config: no call rating defined
• ERR_ENDPOINTCONFIG_107: capping config: invalid max calls count (maxCallsCount)
• ERR_ENDPOINTCONFIG_108: capping config: invalid max calls count (periodInMs)
• ERR_ENDPOINTCONFIG_111: capping config: can’t create endpoint config: invalid payload
• ERR_ENDPOINTCONFIG_112: capping config: can’t create endpoint config: expecting a JSON payload
• ERR_AUTHORING_ENDPOINTCONFIG_1: invalid service name <!--<given value>-->: must be ‘dataSource’ or ‘action’

The potential warning is:

ERR_ENDPOINTCONFIG_106: capping config: max HTTP connections not defined: no limitation by default

Use cases

This section lists key use cases for managing capping configurations in Journey Optimizer and the associated API commands required to implement the use case.

Details on each API command is available in the API description & Postman collection.