Pular para o conteúdo
notemnotemDocumentação

Referência da API › Status

Consultar status

Confirma que a chave funciona e informa o ambiente, a organização e a integração.

GET/api/v1/status

Use para testar a integração. A chamada não acessa o governo e não altera nada.

O ambiente (produção ou homologação), a organização e a integração são definidos só pela chave usada.

Respostas

200 Chave válida

Campos da resposta
ambientetexto
Valores: homologacao, producao
organizacaoobjeto
organizacao.idtexto
UUID
organizacao.nometexto
integracaoobjeto
integracao.idtexto
UUID
integracao.nometexto

401 Chave ausente, inválida ou revogada

Limites

Valem também os limites gerais da chave. Veja Limites de uso.