Primeiros passos

Do zero até a primeira resposta 200, em quatro passos.

1. Obtenha a credencial no ERP

No ERP Objetiva, abra Parâmetros da Filial e gere uma credencial de integração para a filial que a loja vai atender. A tela mostra dois valores:

Valor	Uso
API Key	Identifica a integração. Vai no cabeçalho X-Api-Key, inteira, como a tela a exibe.
Secret Key	Autentica. Vai no cabeçalho X-Api-Secret. É exibido uma única vez; guarde-o no cofre da loja.

Uma credencial vale para uma filial. Se a loja atende mais de uma filial, gere uma credencial por filial e chame a API com cada uma.

observação

A credencial pode ter data de expiração e lista de IPs permitidos, definidos na mesma tela. Fora de qualquer um dos dois, a resposta é 401.

2. Escolha o ambiente

O servidor desta documentação é https://teste-api-ecommerce.objetivaweb.app.br. Todos os exemplos usam esse endereço.

A credencial diz a que ambiente pertence, e GET /integracao devolve isso em ambiente.

3. Confira a credencial

Antes de integrar qualquer coisa, chame o endpoint que devolve a própria credencial:

curl "https://teste-api-ecommerce.objetivaweb.app.br/api/v1/integracao" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SEU_SECRET_KEY"

Resposta esperada:

{
  "sucesso": true,
  "mensagens": [],
  "dados": {
    "nome": "Loja virtual",
    "filial": 1,
    "ambiente": "Homologação",
    "criadaEm": "2026-09-01T09:00:00",
    "expiraEm": null
  }
}

Se vier 401, revise o passo 1: chave copiada incompleta e secret de outra credencial são as causas mais comuns. A resposta não informa qual foi; veja Autenticação.

4. Leia o catálogo e envie um pedido

A partir daqui os dois fluxos principais:

• Sincronizar o catálogo: grupos, marcas, produtos com grades e cores, preços e estoque.
• Enviar um pedido: o pedido fechado na loja entra no ERP pronto para faturar.

Antes deles, vale ler as Convenções: o envelope de resposta, paginação e como os enums são devolvidos valem para todos os endpoints.

Ferramentas

• A Referência tem cada endpoint com parâmetros, schema, exemplos de resposta e exemplo de chamada em curl.
• Uma coleção do Postman com todas as chamadas, pronta para receber a sua credencial, é fornecida pela Objetiva junto com a credencial.