REFERÊNCIA DA API

Serviços

Serviços nacionais e seus cadastros.

GET/services#

Listar services

Permissão necessária services:read

Parâmetros

pagequery · integer

per_pagequery · integer

searchquery · string

national_codequery · string

Respostas HTTP

200

Sucesso

Ver campos da resposta

dataarrayobrigatório

data[].descriptionstring

data[].national_codestring

Código suportado do catálogo oficial; não é CCM legado.

data[].is_activeboolean

data[].idintegerobrigatório

data[].revisionstringobrigatório

metaobjectobrigatório

meta.pageintegerobrigatório

meta.per_pageintegerobrigatório

meta.totalintegerobrigatório

meta.last_pageintegerobrigatório

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/services' \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

POST/services#

Criar services

Permissão necessária services:write

Parâmetros

Idempotency-Keyheader · stringobrigatório

UUID obrigatório em POST/PATCH. Mesmo owner/ambiente/chave com operação ou conteúdo diferente retorna 409.

Corpo da requisição application/json · 3 campos

descriptionstringobrigatório

national_codestringobrigatório

Código suportado do catálogo oficial; não é CCM legado.

is_activebooleanobrigatório

Respostas HTTP

201

Sucesso

Ver campos da resposta

dataobjectobrigatório

data.descriptionstring

data.national_codestring

Código suportado do catálogo oficial; não é CCM legado.

data.is_activeboolean

data.idintegerobrigatório

data.revisionstringobrigatório

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/services' \
  -X POST \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: AQUI_VAI_O_UUID' \
  --data '{
  "description": "AQUI_VAI_O_VALOR",
  "national_code": "AQUI_VAI_O_VALOR",
  "is_active": false
}'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

Exemplo de estrutura: substitua IDs, valores e UUIDs pelos dados conferidos da sua operação. O portal não executa este código.

GET/services/{id}#

Consultar services

Permissão necessária services:read

Parâmetros

idpath · integerobrigatório

Respostas HTTP

200

Sucesso

Ver campos da resposta

dataobjectobrigatório

data.descriptionstring

data.national_codestring

Código suportado do catálogo oficial; não é CCM legado.

data.is_activeboolean

data.idintegerobrigatório

data.revisionstringobrigatório

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/services/{id}' \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

PATCH/services/{id}#

Atualizar services

Permissão necessária services:write

Parâmetros

idpath · integerobrigatório

Idempotency-Keyheader · stringobrigatório

UUID obrigatório em POST/PATCH. Mesmo owner/ambiente/chave com operação ou conteúdo diferente retorna 409.

Corpo da requisição application/json · 4 campos

descriptionstring

national_codestring

Código suportado do catálogo oficial; não é CCM legado.

is_activeboolean

revisionstringobrigatório

Respostas HTTP

200

Sucesso

Ver campos da resposta

dataobjectobrigatório

data.descriptionstring

data.national_codestring

Código suportado do catálogo oficial; não é CCM legado.

data.is_activeboolean

data.idintegerobrigatório

data.revisionstringobrigatório

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/services/{id}' \
  -X PATCH \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: AQUI_VAI_O_UUID' \
  --data '{
  "revision": "AQUI_VAI_O_VALOR"
}'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

Exemplo de estrutura: substitua IDs, valores e UUIDs pelos dados conferidos da sua operação. O portal não executa este código.