Xuru Developers

API, webhooks e guias para integrar

Sincronize pacientes, produtos & estoque e pedidos entre a Xuru e o seu ERP, e-commerce, BI ou automações. REST previsível, JSON, autenticação por API Key e webhooks. Comece em minutos.

REST + JSONOpenAPI 3.1WebhooksSandbox
Primeira chamada — cURL
# Liste seus produtos — basta um header de autenticação
curl https://app.xuru.com.br/api/v1/products \
  -H "X-API-Key: xuru_live_xxxxxxxxxxxxxxxxxxxx"
Upsert por externalId — cURL
# Upsert pelo ID do seu sistema — sem mapear ids da Xuru
curl -X PUT https://app.xuru.com.br/api/v1/patients/external/C0001 \
  -H "X-API-Key: xuru_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "externalId": "C0001", "name": "Maria Souza", "email": "maria@exemplo.com" }'

Feita para ser simples

Menos tempo lendo documentação, mais tempo integrando.

REST previsível

Recursos claros, verbos HTTP padrão e JSON em tudo. Sem surpresas.

Um header para autenticar

Só a sua API Key no header X-API-Key. Ela já escopa sua organização.

Respostas consistentes

Mesmo envelope { success, data, meta } e códigos de erro estáveis em toda a API.

Idempotência nativa

Idempotency-Key garante que retries nunca dupliquem pacientes ou pedidos.

Comece agora

Do zero à primeira sincronização em três passos.

01

Gere sua API Key

No dashboard, em Configurações → Integrações → API Keys. Use a chave de sandbox (xuru_test_) para testar.

02

Autentique

Envie o header X-API-Key em todas as chamadas. A chave escopa sua organização automaticamente.

03

Sincronize

Faça upsert por externalId e leia mudanças com updatedSince. Assine webhooks para tempo real.

Recursos da API

Endpoints versionados sob /api/v1.

Pacientes

Sincronize a base de pacientes/associados.

  • GET/v1/patients
  • GET/v1/patients/{id}
  • POST/v1/patients
  • PUT/v1/patients/{id}
  • PUT/v1/patients/external/{externalId}

Produtos & Estoque

Mantenha catálogo e estoque sempre alinhados.

  • GET/v1/products
  • GET/v1/products/{id}
  • POST/v1/products
  • PUT/v1/products/{id}
  • PUT/v1/products/external/{externalId}
  • PATCH/v1/products/{id}/stock

Pedidos

Crie e acompanhe pedidos com validação automática.

  • GET/v1/orders
  • POST/v1/orders
  • PATCH/v1/orders/{id}/status

Webhooks

Receba eventos em tempo quase real na sua URL.

  • GET/v1/webhooks
  • POST/v1/webhooks
  • GET/v1/events

O que dá para construir

A mesma API atende a vários cenários. Conectar um ERP é só um deles.

ERP

Espelhe pacientes, produtos e pedidos entre o seu ERP (financeiro, fiscal, logística) e a Xuru.

E-commerce externo

Sincronize catálogo e estoque e empurre pedidos da sua loja para a Xuru.

BI / Data warehouse

Leia incrementalmente com updatedSince para alimentar relatórios e dashboards.

Automações

Dispare fluxos internos a partir de webhooks de pedidos, pacientes e estoque.

Conceitos essenciais

Três ideias e você já domina o sincronismo.

externalId

Use o ID do seu sistema para upsert direto (PUT /external/{externalId}) sem mapear ids internos da Xuru.

Delta sync

updatedSince + paginação por cursor trazem apenas o que mudou desde a última sincronização.

Rate limits transparentes

Headers X-RateLimit-* em toda resposta e 429 com Retry-After. Trate com backoff exponencial.

Arquitetura e fluxos

Como os dados trafegam entre o seu sistema e a Xuru.

Arquitetura de integração

Seu sistema fala com a API; a API Key resolve a organização e os dados ficam isolados.

Carregando diagrama...

Escrita (upsert por externalId)

Envie cadastros com o ID do seu sistema — a API cria ou atualiza automaticamente.

Carregando diagrama...

Leitura (delta pull)

Sincronização incremental paginada por cursor.

Carregando diagrama...
Webhooks

Tempo real, sem ficar consultando a API

Ative os webhooks, escolha os eventos e informe a URL de destino. A Xuru entrega notificações assinadas (HMAC), com retentativa automática e garantia de entrega — e suspende endpoints fora do ar para evitar loops.

  • Assinatura HMAC-SHA256 com secret por webhook
  • Retentativa com backoff e reenvio sob demanda
  • Auto-suspensão anti-loop e eventos auditáveis
Ler o guia de webhooks
Criar um webhook — cURL
# Assine eventos e receba notificações na sua URL
curl -X POST https://app.xuru.com.br/api/v1/webhooks \
  -H "X-API-Key: xuru_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://seu-sistema.com/webhooks/xuru",
    "events": ["patient.updated", "order.status_changed", "stock.updated"]
  }'

Pronto para integrar?

Gere sua API Key no dashboard e comece a sincronizar. Precisa de apoio técnico? Nosso time ajuda na integração.