Receitas de API: integrações comuns

Padrões práticos que você pode construir sobre a API do Roldesk. Todos os endpoints ficam sob https://www.roldesk.com/api/v1.

Mantenha os clientes sincronizados

Puxe as alterações desde a sua última sincronização e insira/atualize no seu CRM ou sistema de contabilidade:

GET /customers?updated_since=2026-08-01T00:00:00Z&limit=100

Pagine com next_cursor até que has_more seja falso. Para enviar um cliente novo ao Roldesk, use POST /customers. Use um Idempotency-Key para que as repetições nunca dupliquem.

Crie uma ordem de serviço a partir de um gatilho externo

Quando um chamado ou formulário chega, abra um trabalho:

POST /work-orders
{ "priority": "HIGH",
  "problem": { "title": "Ar-condicionado não gela", "description": "…" },
  "account_id": "…" }

Envie faturas para a sua contabilidade

Leia as faturas à medida que são criadas (pelo webhook invoice.created ou GET /invoices?status=…) e espelhe-as no seu sistema de contabilidade. Os totais são calculados pelo Roldesk, então você pode confiar em subtotal, tax e total.

Evite conflitos nas atualizações

Ao atualizar um registro, inclua expected_updated_at (o valor que você leu por último). Se alguém o alterou primeiro, você receberá um 409 em vez de sobrescrever a edição dele — recarregue e tente de novo.

Respeite os limites de requisições

Cada token permite 100 requisições a cada 10 segundos e 5.000 por hora. Toda resposta inclui X-RateLimit-Remaining; reduza o ritmo quando estiver baixo. Prefira webhooks a fazer sondagens frequentes.

Consulte a referência completa e importe a especificação OpenAPI nas suas ferramentas.