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

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.

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

Nesta seção, você encontrará os cinco principais casos de uso que podem ser executados para gerenciar sua configuração de limitação no Journey Optimizer.

Para ajudá-lo nos testes e configurações, uma coleção do Postman está disponível aqui.

Esta coleção do Postman foi estabelecida como um complemento da coleção variável do Postman gerada pela opção Integrações do console do Adobe I/O > Experimente > Baixar para o Postman, que gera um arquivo de ambiente do Postman com os valores das integrações selecionadas.

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

Na seção a seguir, você encontrará a lista ordenada de chamadas API REST para executar o caso de uso.

Caso de uso nº 1: Criação e implantação de uma nova configuração de limite

Caso de uso nº 2: Atualizar e implantar uma configuração de limitação ainda não implantada

Caso de uso nº 3: Desimplantar e excluir uma configuração de limite implantada

Caso de uso nº 4: Excluir uma configuração de limite implantada.

Em apenas uma chamada de API, é possível desimplantar e excluir a configuração com o uso do parâmetro forceDelete.

Caso de uso n°5: Atualizar uma configuração de limitação já implantada