Utilização das APIs

Para utilizar as APIs é preciso atender a alguns requisitos básicos, tais como enviar o Token nas requisições e que ainda seja válido (não tenha expirado).

Enviar Token

No Header das requisições, sempre enviar o Token, a fim de que a API possa retornar a resposta adequada. Veja abaixo um exemplo de configuração do Header:

Tempo de Expiração

O tempo para expiração da chave de acesso (Token) é de 1h. Portanto, após esse prazo, não será possível verificar respostas para o mesmo Token, será preciso renová-lo.

Renovar Token

Para se obter respostas adequadas para as requisições, recomenda-se que o token seja renovado. Verifique o parâmetro "auth_token", atualizado, no Headers. 

Desta maneira, o token inicial expira em 6h, já o token atualizado irá expirar em 6h, após a nova requisição.

Exemplo de Utilização

1) Acesse a lista de serviços relacionados à Atos Jurídicos, no Swagger.

2) Selecione um serviço, por exemplo o de /atosjuridicos/contrato/enviar/

3) Copie o que está (em json) no campo "Example Value" | Model 

4) Clique em "Execute" e verifique a resposta, principalmente o codigoRegistroInformacao que foi gerado

5) Acesse uma plataforma de testes de API, neste exemplo utilizamos o Postman

6) Configure o EndPoint, Método e Header, de acordo com o que foi indicado em Enviar Token

7) Cole o json que foi copiado, no body da requisição e clique em "Send" (Enviar)

8) Verifique que o código de retorno possui status 201 (Created) e que o Código de Registro de Informação foi gerado