Uso de la API de límite work

La API de límite le ayuda a crear, configurar y supervisar sus configuraciones de límite.

Esta sección proporciona información global sobre cómo trabajar con la API. Hay disponible una descripción detallada de la API en Documentación de las API de Adobe Journey Optimizer.

Descripción de la API de límite y colección de Postman description

En la tabla siguiente se enumeran los comandos disponibles para la API de límite. Encontrará información detallada, incluidos ejemplos de solicitudes, parámetros y formatos de respuesta, en la documentación de API de Adobe Journey Optimizer.

Cuando se crea o actualiza una configuración, se realiza automáticamente una comprobación para garantizar la sintaxis y la integridad de la carga útil.
Si se producen algunos problemas, la operación devuelve advertencias o errores para ayudarle a corregir la configuración.

Además, hay disponible una colección de Postman aquí que le ayudará en la configuración de las pruebas.

Esta colección se ha configurado para compartir la colección Variable de Postman generada mediante Integraciones de la consola de Adobe I/O > Probarla > Descargar para Postman, que genera un archivo de entorno de Postman con los valores de integraciones seleccionados.

Una vez descargado y cargado en Postman, debe añadir tres variables: {JO_HOST},{BASE_PATH} y {SANDBOX_NAME}.

Configuración de extremo

Esta es la estructura básica de una configuración de extremo:

{
    "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>
            }
        },
        ...
    }
}

Por ejemplo:

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

Advertencia y errores

Cuando se llama a un método canDeploy, el proceso valida la configuración y devuelve el estado de validación identificado por su identificador único, ya sea:

"ok" or "error"

Los posibles errores son:

La advertencia potencial es:

ERR_ENDPOINTCONFIG_106: configuración de límite: máximo de conexiones HTTP no definidas: sin limitación de forma predeterminada

Casos de uso

En esta sección se enumeran los casos de uso clave para administrar las configuraciones de límite en Journey Optimizer y los comandos de API asociados necesarios para implementar el caso de uso.

Encontrará detalles sobre cada comando de API en Descripción de la API y recopilación de Postman.