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 API de Adobe Journey Optimizer.

Descripción de API de límite

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.

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 un canDeploy se llama, el proceso valida la configuración y devuelve el estado de validación identificado por su ID ú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 limitaciones predeterminadas

Casos de uso

En esta sección, encontrará los cinco casos de uso principales que puede realizar para administrar la configuración de límite en Journey Optimizer.

Para ayudarle en las pruebas y la configuración, hay una colección de Postman disponible aquí.

Esta colección de Postman se ha configurado para compartir la colección de variables de Postman generada mediante Integraciones de la consola de Adobe I/O > Pruébelo > 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}.

En la siguiente sección, encontrará la lista ordenada de llamadas a la API de REST para ejecutar el caso de uso.

Caso de uso n.º 1: Creación e implementación de una nueva configuración de límite

Caso de uso nº 2: Actualizar e implementar una configuración de límite aún no implementada

Caso de uso nº 3: Anular la implementación y eliminar una configuración de límite implementada

Caso de uso nº 4: Elimine una configuración de límite implementada.

En una sola llamada de API, puede anular la implementación y eliminar la configuración con el uso del parámetro forceDelete.

Caso de uso nº 5: Actualizar una configuración de límite ya implementada