Guia de integração REST

Base URL

https://gestao.simplificagestao.com.br/ords/gestao/

Formato das requisições

Use JSON no envio e no consumo das respostas.

1
Content-Type: application/json
2
Accept: application/json

Dois modelos de autenticação

Hoje o Simplifica trabalha com dois tipos principais de autenticação.

Token privado

Use este modelo quando a documentação do endpoint pedir:

1
Authorization: Bearer {{bearer_token}}

Esse é o formato usado nas integrações privadas da sua empresa, principalmente para:

• consultar dados da plataforma;
• integrar BI, warehouse e relatórios;
• alimentar automações e agentes de IA;
• consumir APIs operacionais privadas.

Na prática: se você vai ler dados do Simplifica, este costuma ser o modelo correto.

Importante:

• o integrador não precisa executar um fluxo externo para obter esse token;
• o token privado já fica disponível no próprio Simplifica;
• a integração apenas copia esse valor e envia Authorization: Bearer.

Token público por chave

Use este modelo quando a documentação do endpoint pedir:

1
x-api-key: {{public_api_key}}

Esse formato é usado em endpoints públicos e controlados de entrada. Hoje, o caso principal documentado é:

• API Lead, para enviar leads externos ao Simplifica.

Comparativo rápido

Onde encontrar seus tokens

No próprio Simplifica existe uma área de Integrações onde a empresa visualiza as credenciais disponíveis.

Lá você encontra:

• o token privado, usado com Authorization: Bearer;
• o token público, usado com x-api-key nos canais que aceitam chave pública.

Como saber qual autenticação usar

• se o endpoint mostrar Authorization: Bearer, use o token privado;
• se o endpoint mostrar x-api-key, use o token público daquele canal;
• hoje a API Lead usa token público;
• as APIs de consulta e a maior parte das integrações futuras tendem a usar token privado.

Não misture os dois formatos.

Regras práticas

• sempre envie Content-Type: application/json quando houver body JSON;
• nunca exponha tokens ou chaves reais em exemplos;
• teste primeiro a chamada base mais simples;
• só depois adicione filtros, paginação ou payloads mais completos;
• cada API pode ter regras próprias de autenticação, resposta e validação.

Observações importantes

• tokens e chaves podem ser revogados ou substituídos a qualquer momento;
• a x-api-key pública deve ser usada apenas nos módulos que a documentam explicitamente.