Pular para o conteúdo principal

idworks API

Bem-vindo à referência da API pública idworks. Esta documentação descreve todos os endpoints, parâmetros, respostas e códigos de erro disponíveis para integradores.

Autenticação​

Todas as requisições devem incluir o header Authorization: Bearer <token>. O token JWT é obtido via POST /auth/token.

curl -H "Authorization: Bearer SEU_TOKEN" \
  https://{AccountName}.api-idworks.com.br/1.0/account

URL base​

Cada cliente acessa a API por um subdomínio próprio derivado do nome da sua conta:

https://{AccountName}.api-idworks.com.br/1.0/

Substitua {AccountName} pelo nome da sua conta idworks (ex: se sua conta é acme, a URL fica https://acme.api-idworks.com.br/1.0/).

Rate limits​

O limite padrão é de 5 requisições/segundo por endpoint por conta. Respostas excedendo o limite retornam 429 Too Many Requests com o header Retry-After.

Como navegar​

Use a barra lateral à esquerda para explorar os recursos. Cada endpoint mostra parâmetros, exemplos de request/response e um botão Send API Request para testar diretamente do navegador.

:::tip Testando a API direto do navegador No painel direito de cada endpoint, clique em Edit ao lado da Base URL para trocar AccountName pelo nome da sua conta (ou mantenha teste para usar a conta de demonstração). Cole o JWT no campo Auth e clique Send API Request. :::