Obter Programações (Webhook)

Requisição

Segurança

API-Key and Client-Code

Consulta

OSCodeintegerobrigatório

SerialNumberstring

UserCodeinteger

Corpoapplication/json

callbackUrlstring

credentialsobject

curl -i -X POST \
  'https://api-alliances.inflor-qas.cloud/api/v2/silvicultura/programacoes/webhook?OSCode=0&SerialNumber=string&UserCode=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Client-Code: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "callbackUrl": "string",
    "credentials": {
      "authorization": "string"
    }
  }'

Respostas

A requisição será processada assincronamente e seu resultado será retornado na URL de Webhook informada.

Corpoapplication/json

requestIdstring or null

statusstring

Resultado da requisição. Lista aberta: novos valores podem ser adicionados; clientes devem tolerar valores desconhecidos.

Enum:"success""processing""accepted""bad_request""unprocessable_entity""error""service_unavailable"

Exemplo:"success"

messagestring

dadosnull

errorsobject or null

Erros de validação ou de recusa, por campo (campo -> lista de mensagens). A chave $ identifica uma recusa sem campo específico. É nulo nas falhas técnicas.

statusUrlstring

Resposta

{
  "requestId": "string",
  "status": "success",
  "message": "string",
  "dados": null,
  "errors": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "statusUrl": "string"
}