Pular para o conteúdo principal
Versão: 1.0

API de integração e-commerce — Objetiva

Integração entre plataformas de e-commerce e o ERP Objetiva: leitura do catálogo, do estoque, dos preços e dos clientes de uma filial, e recebimento dos pedidos fechados na loja.

Autenticação​

Toda rota sob /api exige dois cabeçalhos, emitidos na tela de Parâmetros da Filial do ERP:

  • X-Api-Key: a API Key, copiada inteira como a tela a exibe.
  • X-Api-Secret: o Secret Key, exibido uma única vez ao gerar a credencial.

Uma credencial vale para uma filial. Toda consulta e todo pedido ficam restritos a ela, e nenhum endpoint aceita filial como parâmetro. Credencial ausente, inválida, inativa, expirada ou fora do IP permitido recebe sempre a mesma resposta 401, sem dizer qual foi o motivo.

Envelope de resposta​

Toda resposta JSON tem o mesmo formato: sucesso (booleano), mensagens (lista de textos) e, quando houver, dados. Erro de validação vem como 400 com a causa em mensagens; sucesso com aviso vem como 200 com sucesso: true e a lista preenchida.

Paginação e ordenação​

As listagens aceitam pagina, tamanhoPagina (padrão 50, máximo 200), ordenarPor e descendente. Cada endpoint aceita uma lista própria de campos em ordenarPor; valor fora dela devolve 400 com os aceitos. A resposta traz itens, paginaAtual, tamanhoPagina, totalItens, totalPaginas e temProxima.

Enums​

Todo enum do ERP sai como número, que é o valor gravado e o que não muda, acompanhado de um campo *Descricao com o texto que o ERP mostra. A lista de valores de cada um está na descrição do campo.

Limites​

A cota é por credencial, em duas janelas: por minuto e por hora. Excedida, a resposta é 429 com o cabeçalho Retry-After em segundos.

Versionamento​

A versão vai na URL (/api/v1/...). Chamada sem versão não é atendida. As versões suportadas são anunciadas no cabeçalho api-supported-versions das respostas que chegam a um endpoint; 401 e 429 são decididos antes disso e não o trazem.

Autenticação​

Identifica a integração. Use o valor inteiro, exatamente como a tela de Parâmetros da Filial o exibiu.

Tipo de esquema:

apiKey

Cabeçalho:

X-Api-Key

Contato

Objetiva Soluções: teste@gmail.com

Site: https://www.objetivasolucoes.com.br