Pular para o conteúdo principal

v1.0 — Lançamento da documentação pública

Equipe idworks
Equipe idworks
API

Hoje publicamos a primeira versão da referência pública da API idworks. Este portal documenta os endpoints disponíveis para integradores e oferece um ambiente para testes diretos do navegador.

O que está disponível nesta versão​

Cobertura da API​

  • 772 endpoints documentados a partir do spec OpenAPI 3.0 do idworks
  • 126 schemas de request/response com tipos, campos obrigatórios e exemplos
  • 28 categorias com sub-agrupamento automático por recurso (ex: Accounts ▸ Payable, Sku ▸ Production, Hub ▸ Product)

Autenticação integrada​

  • Formulário de login na introdução com AccountName + e-mail + senha
  • Token JWT obtido via POST /user/signin/local e aplicado automaticamente em todos os endpoints — sem precisar copiar e colar
  • Sessão em memória da aba (não persiste após fechar)
  • Botão "Login" no canto superior direito para trocar de conta sem voltar para a introdução

Try-it (Send API Request)​

  • Painel à direita de cada endpoint para enviar requests reais
  • Code samples em cURL, JavaScript, Python, PHP, Go, Ruby, Java e C#
  • URL base por conta (https://{AccountName}.api-idworks.com.br/1.0/) com variável editável
  • Botão Edit para trocar a conta diretamente sem refazer o login
  • Busca tipo "Jump to..." com atalho ⌘K / Ctrl+K indexando 100% do conteúdo
  • Sidebar hierárquica com auto-collapse — só a categoria atual fica aberta
  • Seção Models separada no fim com todos os schemas reutilizáveis
  • Tema claro/escuro respeitando prefers-color-scheme

Limites da API​

  • 5 requisições/segundo por endpoint por conta — exceder retorna 429 Too Many Requests com o header Retry-After

Próximos passos planejados​

  • Quickstart com fluxo "do zero ao primeiro pedido"
  • Tutorial de webhooks e eventos
  • Exemplos prontos por linguagem (snippets reais, não só schemas)
  • Documentação de paginação e idempotência

Encontrou algo errado? Tem sugestão? Manda pra dev@idworks.com.br.