Páginas filhas
  • Introdução Hub de Integração TOTVS Moda

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Todas as URLs e documentações estão disponíveis no swagger de cada API disponível para acesso através dos host  Base oficial ou Base treino

Segurança

É necessário informar o seu token de acesso para todas as URLs que serão acessadas. Além de utilizá-lo como parâmetro na URL, é possível passá-lo como cabeçalho da requisição. O nome gumgaToken deve ser utilizado para ambas as formas.

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 10 requisições por segundo por token.

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

O Token Authentication tem a responsabilidade de autenticar os usuários nas diversas API's, utilizamos para geração e validação de tokens no padrão Jason Web Token (JWT), criptografados, que serão utilizados durante as requisições às API's, garantindo assim, a autenticidade das informações entre as duas partes (back-end e front-end ou de um back-end para outro back-end).

Outro ponto importante  para verificar a integridade dos dados é a chave de acesso única ou conhecido como "x-api-key" onde o mesmo é gerado exclusivamente para cada cliente e está é obrigatório ser informando em todas as  requisições.

Trabalhando juntas e aumentando a segurança e a integridade dos seus dados.


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": "http://sandbox-api.anymarket.com.br/v2/categories?offset=0"
    },
    {
      "rel": "next",
      "href": "http://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.

...

  • :
  • offset: Indica a partir de qual recurso a consulta irá começar
  • 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

...