Sobre

...

O Hub de Integração TOTVS Moda é um passo importante para a inovação a ponto de facilitar a sua integração aos diversos segmentos.

Com está nova estrutura será permitida a sua utilização para aplicações existentes ou novas de forma simples e ágil.

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

O Token de Autorização tem a responsabilidade de autenticar os usuários nas diversas API's,

utilizamos para geração e validação de tokens no padrão 

...

É 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.

Segurança

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.

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

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.

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:

...

Json 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 este é 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.

Abaixo temos um exemplo de como gerar o Token de Autorização pelo Postman, importando através de uma cURL.

Na aba Headers temos o campo x-api-key, onde deve ser inserida a chave de acesso única.

Na aba Body temos os campos onde devem ser inseridas as credenciais do cliente.

Image Added

Lista

Abaixo a lista contendo as API's e o link de sua documentação com suas funcionalidades disponíveis para utilização.

<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>