RA API
Visão geral
A RA API da Redtrust é uma API REST que implementa as operações de uma autoridade de registro (RA). Permite que parceiros com capacidade de emissão de certificados gerenciem o ciclo de vida completo do processo de enrollment: autenticação, geração de chaves, criação do CSR, emissão e renovação de certificados digitais.
É projetada para integradores que atuam como autoridades de registro dentro da infraestrutura de PKI da Redtrust.
URL base
https://SEU_IP_REDTRUST:PORTA/raapi
A porta padrão é 8082. Por exemplo: https://localhost:8082/raapi/v1/csr/create.
Onde:
SEU_IP_REDTRUSTé o endereço IP ou o nome do host do seu servidor Redtrust.PORTAé a porta de acesso ao serviço.
Autenticação
A RA API suporta dois mecanismos de autenticação:
Login direto com credenciais
Para integrações servidor a servidor, autentique o usuário diretamente com POST /raapi/v1/auth/login. Este endpoint retorna um token de acesso e um token de atualização prontos para uso.
Fluxo de redirecionamento com HMAC
Para integrações que exigem que o usuário se autentique por meio de uma interface web da Redtrust, use o fluxo de redirecionamento: redirecione o usuário para /authclient/auth/loginrequest com Consumer=RA_API, troque o token temporário recebido por um token de acesso e use-o para chamar a RA API. Consulte o guia de integração com Certificate Enroll para o passo a passo detalhado deste fluxo.
Em ambos os casos, inclua o token de acesso em todas as chamadas aos endpoints protegidos:
Authorization: Bearer SEU_ACCESS_TOKEN
Você pode atualizar o token de acesso a qualquer momento com PUT /raapi/v1/auth/refresh-token, sem precisar se autenticar novamente.
Formato de resposta
Todos os endpoints retornam a seguinte estrutura JSON:
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "string",
"data": {}
}
| Campo | Descrição |
|---|---|
message | Mensagem descritiva do resultado. |
messageType | SUCCESS se a operação foi concluída com sucesso; ERROR se ocorreu algum problema. |
errorCode | Código identificador do erro, ou OK quando a operação é bem-sucedida. |
data | Conteúdo da resposta. O tipo varia conforme o endpoint. |