Como executar um service

O mesmo fluxo vale para todos os services do catálogo.

Ainda não disponível. Estas páginas descrevem o contrato previsto para /api/token-generate e /api/service-api, que ainda não respondem no servidor. A API ativa hoje é a REST v1.

1. Gere o token

Siga Autenticação e envie o token no header Authorization.

2. Escolha o service

Procure pelo objetivo em Services por caso de uso, ou direto nos catálogos de pessoa física e pessoa jurídica. Use o alias exatamente como aparece.

3. Monte o body

O campo service é sempre obrigatório. Cada página de service lista os outros campos.

4. Execute

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PJ",
  "cnpj": "00000000000000"
}'

5. Leia a resposta

{
  "result": {},
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Campo	Descrição
`result`	Dados da consulta; o formato muda conforme o service
`status.code`	Resultado do processamento, separado do status HTTP
`status.message`	Mensagem do processamento
`externalId`	Identificador da consulta; guarde para suporte e auditoria

Confira sempre status.code e status.message: uma resposta HTTP 200 pode trazer falha de processamento. Veja Status e erros.