Funcionalidades Adicionais
Listar Solicitações
<h2>Endpoint para listar as requisição de certificado da AR.</h2>Esta rota suporta filtros para refinar busca.
<h3>Filtros disponíveis:</h3>Os filtros devem ser adicionados como Query Params.
| Nome do filtro | Descrição | Valor Exemplo |
|---|---|---|
| cpf | CPF do solicitante. | 00000000191 |
| protocol | Protocolo da Solicitação. | wc8-kj3a-776 |
| cnpj | CNPJ do solicitante. | 00000000000191 |
| common_name | Common Name (nome codificado no certificado). | Joao Silva |
| certificate_authority_id | ID da Autoridade Certificadora | 1 |
| registration_authority_id | ID da Autoridade de Registro | 1 |
| registry_office_id | ID do Posto de Atendimento | 1 |
| product_id | ID do Produto | 1 |
| result[] | Estado atual da solicitação. <br>Valores possíveis: received. in_validation, approved, validation_rejected, rejected, issued e revoked. <br>Pode ser repetido para buscar por mais de um estado. | received |
| created_at | Limita a busca a solicitações criadas num período entre esta data e 24h após esta data. <br>Fuso horário UTC. <br>Data no formato <br>Y-m-dTH:i:s.000Z ou Y-m-d H:i:s | 2023-04-11T03:00:00.000Z <br>2023-04-11 03:00:00 |
| created_at_start | Limita a busca a solicitações criadas após esta data. <br>Fuso horário UTC. <br>Data no formato: <br>Y-m-dTH:i:s.000Z ou Y-m-d H:i:s | 2023-04-11T03:00:00.000Z <br>2023-04-11 03:00:00 |
| created_at_end | Limita a busca a solicitações criadas até esta data. <br>Fuso horário UTC. <br>Data no formato: <br>Y-m-dTH:i:s.000Z ou Y-m-d H:i:s | 2023-04-11T03:00:00.000Z <br>2023-04-11 03:00:00 |
| finalized_at | Limita a busca a solicitações aprovadas num período entre esta data e 24h após esta data. <br>Fuso horário UTC. <br>Data no formato: <br>Y-m-dTH:i:s.000Z ou Y-m-d H:i:s | 2023-04-11T03:00:00.000Z <br>2023-04-11 03:00:00 |
| finalized_at_start | Limita a busca a solicitações aprovadas após esta data. <br>Fuso horário UTC. <br>Data no formato: <br>Y-m-dTH:i:s.000Z ou Y-m-d H:i:s | 2023-04-11T03:00:00.000Z <br>2023-04-11 03:00:00 |
| finalized_at_end | Limita a busca a solicitações aprovadas até esta data. <br>Fuso horário UTC. <br>Data no formato: <br>Y-m-dTH:i:s.000Z ou Y-m-d H:i:s | 2023-04-11T03:00:00.000Z <br>2023-04-11 03:00:00 |
| issued_at | Limita a busca a solicitações emitidas num período entre esta data e 24h após esta data. <br>Fuso horário UTC. <br>Data no formato: <br>Y-m-dTH:i:s.000Z ou Y-m-d H:i:s | 2023-04-11T03:00:00.000Z <br>2023-04-11 03:00:00 |
| issued_at_start | Limita a busca a solicitações emitidas após esta data. <br>Fuso horário UTC. <br>Data no formato: <br>Y-m-dTH:i:s.000Z ou Y-m-d H:i:s | 2023-04-11T03:00:00.000Z <br>2023-04-11 03:00:00 |
| issued_at_end | Limita a busca a solicitações emitidas até esta data. <br>Fuso horário UTC. <br>Data no formato: <br>Y-m-dTH:i:s.000Z ou Y-m-d H:i:s | 2023-04-11T03:00:00.000Z <br>2023-04-11 03:00:00 |
| sort | Indica qual campo será utilizado para ordenar os resultados. <br>Valores possíveis: common_name, protocol, result, status e created_at. | created_at |
| direction | indica a direção da ordenação. <br>Valores possíveis: asc e desc. | desc |
Veja o uso dos filtros nos exemplos disponíveis.
<h3>Códigos de ERRO:</h3> <table><tbody><tr><th>HTTP</th><th>error_id</th><th>error_code</th><th>message</th></tr><tr><td><div>500</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>4000</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>ar_universal.erro.listar.requisicao_certificado</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>Falha ao listar as Requisições de certificado.</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>get/api/certificate-requests
Headers
Content-Typestring
Authorizationstring
Response
OK
object required