Guides

Guia prático para integrar seu ERP à API do OtimizApp Pharma

Ver API Reference Abrir Sandbox
Integration Guides

Onboarding técnico pensado para acelerar integrações com ERPs farmacêuticos.

Siga a sequência recomendada para autenticar, sincronizar catálogo, processar pedidos e validar a integração no sandbox antes de colocar o fluxo em operação.

Fluxo Guided
Sandbox Disponível

Navegação

Acesso rápido aos tópicos

Autenticação Sincronização de ofertas Leitura de pedidos Atualização de status Webhooks Checklist final
Recomendação

Valide toda a integração no sandbox antes de usar o ambiente operacional.

1. Autenticação

Todas as chamadas protegidas exigem Bearer Token e API Key

Authorization: Bearer SEU_TOKEN
X-API-Key: SUA_API_KEY

2. Sincronização de ofertas

Publique catálogo, preço e estoque no endpoint de ofertas

Enviar ofertas em lote
Use PUT /offers para atualizar preço, disponibilidade e regras da oferta.
Validar por EAN
Use GET /offers/{ean} para conferir se o produto foi refletido corretamente.

3. Leitura de pedidos

Consuma a fila de pedidos da plataforma

GET /api/v1/orders
GET /api/v1/orders/{ref_id}

O fluxo recomendado é listar pedidos paginados, buscar o detalhe por ref_id e então disparar o processamento no ERP.

4. Atualização de status

Mantenha o cliente e a plataforma sincronizados com a operação da loja

Pedido recebido
Confirme o recebimento para sinalizar que o pedido entrou em preparo.
Tracking / envio
Atualize entrega, separação e expedição conforme a operação avança.
Cancelamento
Use cancelamento total ou parcial quando houver falta de item ou ruptura.

5. Webhooks

Configure uma callback URL para receber eventos operacionais

PATCH /api/v1/settings/callback-url

{
  "callback_url": "https://seu-erp.com/webhook"
}

Eventos como ORDER_CREATED, ORDER_UPDATED, ORDER_CANCELLED e ORDER_DELIVERED podem ser usados para automatizar o fluxo entre a plataforma e o ERP.

6. Checklist final

Antes de subir para operação, valide estes itens