Primeiros passos com a API do Roldesk

A API REST do Roldesk permite que seus outros softwares leiam e atualizem os dados do seu espaço de trabalho — ordens de serviço, clientes, faturas, contratos e muito mais. Está disponível no plano Professional.

1. Crie um token de acesso

Vá em Configurações → Desenvolvedor (apenas proprietário ou administrador) e crie um token de acesso pessoal. Escolha os escopos de que ele precisa — por exemplo, crm:read para ler clientes ou work-orders:write para criar trabalhos. Copie o token agora — ele é exibido apenas uma vez.

2. Verifique se funciona

Envie o token como cabeçalho Bearer. O endpoint /me confirma o token e mostra seu espaço de trabalho:

curl https://www.roldesk.com/api/v1/me \
  -H "Authorization: Bearer rk_live_…"

3. Leia alguns dados

curl "https://www.roldesk.com/api/v1/work-orders?limit=25" \
  -H "Authorization: Bearer rk_live_…"

As listas são paginadas: passe limit (até 100) e o next_cursor da resposta anterior para obter a próxima página. Você pode filtrar com status, account_id e updated_since.

4. Crie ou atualize dados

curl -X POST https://www.roldesk.com/api/v1/customers \
  -H "Authorization: Bearer rk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Corp", "email": "ops@acme.com"}'

Adicione um cabeçalho Idempotency-Key para repetir a requisição com segurança sem criar duplicatas.

Para onde ir agora

• Referência completa: roldesk.com/developers
• Importar para o Postman/Insomnia: a especificação OpenAPI em /api/v1/openapi.json
• Eventos em tempo real: consulte o artigo sobre Webhooks.