Cria um registro. Exige chave de leitura e escrita com usuário responsável; mande Idempotency-Key para poder repetir sem duplicar. A criação dispara os webhooks e as automações da conta, como a tela.
Exige chave de escrita e Idempotency-Key (repetir a mesma chave e o mesmo corpo devolve a resposta congelada, com Idempotency-Replayed). O dono da chave precisa poder incluir na tela /pages/suprimentos/ordem-producao.xhtml (403 sem isso). Corpo: {"idOrdemProducao": 55, "idEtapa": 3, "idFuncionario": 7, "qtdBoa": 120, "qtdRefugo": 2, "motivoRefugo": "furo", "horas": 1.5, "descricao": "..."}
Escopo da chave
Exige chave de leitura e escrita (READ_WRITE) com usuário responsável.
Parâmetros
Nome
Onde
Tipo
Obrigatório
Descrição
Authorization
header
string
sim
Bearer seguido da chave. Alternativa: cabeçalho X-API-Key.
Idempotency-Key
header
string
não
Chave de idempotência (guardada por 24h, corpo de até 2 MB). Repetir a MESMA chave com o MESMO corpo devolve a resposta original gravada, marcada com o header X-Idempotency-Replay: true — nada é executado de novo. A mesma chave com corpo DIFERENTE recebe 409 (conflito); a mesma chave enquanto a primeira execução ainda roda recebe 409 com Retry-After: 5. Resposta 5xx não congela a chave: a repetição executa de novo.
Corpo da requisição
Nome
Tipo
Obrigatório
Descrição
Campos da resposta
Nome
Tipo
Descrição
id
integer
Identificador do registro. Use-o nas chamadas por id.
codigo
integer
Código do registro como aparece na tela.
nome
string
Nome.
Códigos de status
HTTP
Descrição
201
Criado — devolve o id e o resumo
403
Chave somente leitura ou dono sem acesso à tela
409
Idempotency-Key reutilizada com outro corpo, ou ainda em processamento
413
Corpo acima do teto da escrita idempotente
422
Dado inválido — o motivo vem em erro
503
Idempotência indisponível — repita a mesma Idempotency-Key
Mensagens de erro
HTTP
Mensagem (campo erro)
Quando acontece
401
chave de API ausente ou inválida
Sem cabeçalho de chave, chave revogada ou digitada errada.
401
chave sem empresa vinculada
A chave existe mas não está ligada a uma conta. Gere outra em Configurações › API.
403
conta de demonstração: a API pública está desligada na vitrine
A chamada veio para a conta de demonstração: lá a API pública fica desligada.
403
identidade da chave de API irregular
A conta recusa chaves com identidade irregular (pessoa desligada ou chave sem dono). O corpo traz motivo e comoResolver.
429
limite de requisições excedido (120/min)
Passou do limite por minuto da chave. Espere o Retry-After.
403
esta chave é somente leitura — gere uma chave com escopo de escrita
Escrita com chave de escopo somente leitura.
409
a chave não tem usuário responsável; recrie a chave em Configurações → API para que os registros criados tenham autoria
A chave de escrita não tem usuário responsável: sem autoria, nada é gravado.
400
Idempotency-Key é obrigatória em escrita desde 2026-12-01 (aviso publicado em 2026-09-01): sem ela, um retry de rede cria o registro duas vezes. Envie um valor único por operação no cabeçalho Idempotency-Key.
Escrita sem Idempotency-Key depois da data de obrigatoriedade.
409
Idempotency-Key já usada com um corpo DIFERENTE — gere uma chave nova por operação
A mesma Idempotency-Key veio com outro corpo.
409
requisicao com esta Idempotency-Key ainda em processamento — aguarde e repita
A mesma Idempotency-Key chegou enquanto a primeira chamada ainda rodava. Repita depois do Retry-After.
400
JSON inválido
O corpo não é um objeto JSON válido.
422
nome é obrigatório
Faltou nome, ou veio vazio.
422
não foi possível criar: {detalhe}
A gravação foi recusada (por exemplo, valor maior que o campo aceita). O detalhe vem na mensagem.