Função ConsultarCertificado ( )
Para consultar o certificado utilize o seguinte método HTTP: POST/ConsultarCertificado
O conteúdo do POST deverá conter somente os dados de identificação de acesso a API. O resultado será sucesso na consulta ou erro de validação.
|
Campo |
Tipo |
Obrigatório |
Descrição |
|---|---|---|---|
|
ApiKey |
Texto |
Sim |
A ApiKey é identificação do desenvolvedor e poderá ser obtida dentro do PORTAL WEB da API |
|
Cnpj |
Texto |
Sim |
CNPJ da Empresa que deseja consultar o Status do Certificado |
Exemplo de JSon
{
"ApiKey":"xxxapikeyhashxxx"
"Cnpj":"00.000.000/0000-00"
}
Retornos e Erros
Todos os códigos de erros com os dois primeiros dígitos sendo 40 são associados a função: ConsultarCertificado| Código | Campo | Mensagem de retorno |
|---|---|---|
| 401 | Cnpj | O CNPJ informado não foi localizado! |
| 402 | ApiKey | A ApiKey deve ser informada para acesso! |
| 403 | Retorno com erro | |
| 404 | Retorno com sucesso | |
Retornos de JSON
| Retorno com erro de parametros |
|---|
| { "Status": "Erro", "codigo": "codigo_erro", "campo": "campo_com_erro", "descricao": "descricao_erro" } |
| Retorno com erro |
|---|
| { "status": "Erro", "codigo": "403", "descricao": "descricao_erro" } |
| Retorno com sucesso |
|---|
| { "status": "OK", "codigo": "404", "descricao": "Consulta realizada com sucesso!" "resultado":{ "razao_social": "razao_social", "status": "status_certificado", "dias para expirar": "dias_para_expirar", "data de expiração": "data_expiracao" } } |