Trabalhar com a API de limite work

A API de limite ajuda a criar, configurar e monitorar as configurações de limite.

Esta seção fornece informações globais sobre como trabalhar com a API. Uma descrição detalhada da API está disponível na documentação das APIs do Adobe Journey Optimizer.

Descrição da API de limite e coleção do Postman description

A tabela abaixo lista os comandos disponíveis para a API de limitação. Informações detalhadas, incluindo amostras de solicitações, parâmetros e formatos de resposta estão disponíveis na documentação das APIs do Adobe Journey Optimizer.

Quando uma configuração é criada ou atualizada, uma verificação é executada automaticamente para garantir a sintaxe e a integridade do payload.
Se ocorrerem alguns problemas, a operação retornará um aviso ou erros para ajudá-lo a corrigir a configuração.

Além disso, uma coleção do Postman está disponível aqui para ajudá-lo na configuração de teste.

Esta coleção foi configurada para compartilhar a coleção de Variáveis Postman gerada por meio das Integrações do Console Adobe I/O > Experimente > Baixar para Postman, que gera um arquivo de Ambiente Postman com os valores de integrações selecionados.

Após o download e o upload para o Postman, é necessário adicionar três variáveis: {JO_HOST},{BASE_PATH} e {SANDBOX_NAME}.

Configuração do endpoint

Esta é a estrutura básica de uma configuração de endpoint:

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

Exemplo:

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

Aviso e erros

Quando um método canDeploy é chamado, o processo valida a configuração e retorna o status de validação identificado por sua Identificação Exclusiva:

"ok" or "error"

Os possíveis erros são:

O aviso potencial é:

ERR_ENDPOINTCONFIG_106: configuração de limitação: máximo de conexões HTTP não definidas: sem limitação por padrão

Casos de uso

Esta seção lista casos de uso importantes para gerenciar configurações de limite no Journey Optimizer e os comandos de API associados necessários para implementar o caso de uso.

Detalhes sobre cada comando de API estão disponíveis na descrição da API e coleção do Postman.