Pular para o conteúdo principal

Observações

Algun pontos importantes sobre a integração com o ANYMARKET:

Limites​

Seja legal. Se você estiver enviando muitas requisições rapidamente, nós retornaremos um código de erro 429 (too many requests). Você tem um limite de:

image.png

Cabeçalhos de Controle de Rate Limit​

Ao realizar chamadas para a API, os seguintes cabeçalhos serão retornados para informar sobre os limites de requisições:

  • ratelimit-reset: Indica o tempo restante (em segundos) para que o limite de requisições seja renovado e volte ao máximo permitido pelo endpoint.
  • ratelimit-limit: Define o limite máximo de requisições que o endpoint suporta dentro do período estabelecido.
  • ratelimit-remaining: Mostra o número de requisições restantes que podem ser feitas no minuto atual. Este valor diminui a cada requisição realizada.

Esses cabeçalhos ajudam a gerenciar o uso da API de forma eficiente e evitar exceder os limites estabelecidos.

Operações​

Nós fazemos o nosso melhor para que todas as nossas URLs sejam RESTful. Cada URL pode suportar um dos quatro diferentes tipos de verbos http:

  • GET obtém informações sobre um recurso
  • POST cria um recurso
  • PUT atualiza um recurso
  • DELETE exclui um recurso

Estrutura​

Paginação​

A grande maioria das requisições que retornam uma coleção de recursos são paginadas. Por exemplo, a consulta de categorias principais. Toda resposta paginada é retornada no seguinte formato:

{
  "links": [
    {
      "rel": "prev",
      "href": "https://sandbox-api.anymarket.com.br/v2/categories?offset=0"
    },
    {
      "rel": "next",
      "href": "https://sandbox-api.anymarket.com.br/v2/categories?offset=4"
    }
  ],
  "content": [
    ...
  ],
  "page": {
    "size": 2,
    "totalElements": 6,
    "totalPages": 3,
    "number": 1
  }
}

Para facilitar a navegação sequencial de dados, nós disponibilizamos links para ir a próxima página ou retornar a anterior.

Por padrão a consulta retorna 20 recursos por página. No entanto, nós permitimos que esse número seja aumentado até um máximo de 100. Abaixo segue os parâmetros que alteram a forma como a pagina é retornada:

  • offset: Indica a partir de qual recurso a consulta irá começar. Para a consulta começar da página inicial, o offset deverá ter o valor igual a 0.
  • limit: Indica a quantidade de recursos a serem retornados, indo de 20 a no máximo 100.
  • sort: Indica por qual atributo a consulta deve ser ordenada

Data​

Todo Atributo que receba uma Data deve ser informada passando o Fuso Horario.
Se o parceiro controla o Fuso Horário deverá controlar também o horário de verão, fazendo as alterações necessárias.

Exemplo:
08/03/2018 10:00:00 Fuso Horário GMT-3
Deve ser informado da seguinte forma 2018-03-08T10:00:00-03:00 Validação para as Datas do Pedido:

  • A "DATA DE CRIAÇÃO" (createdAt) do pedido não pode ser vazia.
  • A "DATA DE EMISSÃO DE NOTA FISCAL" (date) Objeto[invoice] deve ser maior ou igual "DATA DE CRIAÇÃO" (createdAt) do pedido.
  • A "DATA DE EMISSÃO DE NOTA FISCAL" (date) Objeto[invoice] deve ser maior "DATA DE PAGAMENTO" (paymenteDate) do pedido.
  • A "DATA DE PAGAMENTO" (paymenteDate) deve ser maior "DATA DE CRIAÇÃO" (createdAt) do pedido.
  • A "DATA DE ENVIO" (date) Objeto[tracking] deve ser maior ou igual "DATA DE EMISSÃO DE NOTA FISCAL" (date) Objeto[invoice] do pedido..
  • A "DATA DE ENVIO" (date) Objeto[tracking] deve ser maior "DATA DE CRIAÇÃO" (createdAt) do pedido.
  • A "DATA DE ENTREGA" (deliveredDate) Objeto[tracking] deve ser maior ou igual "DATA DE ENVIO" (date) Objeto[tracking] do pedido.
  • A "DATA DE PREVISÃO DE ENTREGA" (estimateDate) Objeto[tracking] deve ser maior ou igual "DATA DE ENVIO" (date) Objeto[tracking] do pedido.