Referência de endpoints da RA API

Esta página documenta todos os endpoints da RA API. Para informações sobre autenticação e o formato de resposta, consulte a visão geral da RA API.

Autenticação

Fazer login

Autentica um usuário com suas credenciais e retorna um token de acesso e um token de atualização.

POST /raapi/v1/auth/login

Parâmetro	Valor
Autenticação	Não obrigatória
Content-Type	application/json

Body

{
  "username": "string",
  "password": "string",
  "domain": "string"
}

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "accessToken": "string",
    "refreshToken": "string",
    "expiration": "string"
  }
}

---

Atualizar o token

Obtém um novo token de acesso usando um token de atualização válido.

PUT /raapi/v1/auth/refresh-token

Parâmetro	Valor
Autenticação	Não obrigatória
Content-Type	application/json

Body

{
  "refreshToken": "string"
}

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "accessToken": "string",
    "refreshToken": "string",
    "expiration": "string"
  }
}

---

Fazer logout

Invalida o token de atualização do usuário autenticado.

DELETE /raapi/v1/auth/logout

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Body	—

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {}
}

---

Geração do CSR

Criar o CSR

Gera um par de chaves no servidor e retorna um CSR junto com um requestCode para concluir a emissão ou renovação.

POST /raapi/v1/csr/create

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Content-Type	application/json

Body

{
  "dn": [
    {
      "attribute": "string",
      "value": "string"
    }
  ],
  "hashType": "SHA384",
  "keyLength": 2048,
  "keyType": "RSA",
  "provider": "string",
  "requestCode": "string",
  "info": {
    "proident_9b": "string"
  },
  "groupIds": [0],
  "thumbprintToRenew": "string"
}

Campo	Tipo	Obrigatório	Descrição
dn	array	Sim	Lista de atributos do Distinguished Name (DN). Cada elemento tem um attribute (por exemplo, cn, o, c) e um value.
hashType	string	Sim	Algoritmo de hash. Por exemplo: SHA256, SHA384, SHA512.
keyLength	integer	Sim	Comprimento da chave em bits. Por exemplo: 2048, 4096.
keyType	string	Sim	Tipo de chave. Por exemplo: RSA, DSA.
provider	string	Sim	Nome do provedor de certificados (CA) configurado na Redtrust.
requestCode	string	Não	Identificador da solicitação. Opcional na primeira emissão.
info	object	Não	Informações adicionais específicas do provedor.
groupIds	array	Não	Lista de identificadores de grupos de certificados aos quais o certificado é atribuído.
thumbprintToRenew	string	Não	Thumbprint do certificado que está sendo renovado. Inclua este campo apenas em operações de renovação.

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "requestCode": "string",
    "csr": "string"
  }
}

Campo	Descrição
data.requestCode	Identificador da solicitação. Você deve incluí-lo na chamada a PUT /raapi/v1/csr/finalize.
data.csr	CSR gerado codificado em Base64.

Exemplo de emissão

Request

{
  "dn": [
    { "attribute": "cn", "value": "john doe" },
    { "attribute": "o", "value": "Redtrust" },
    { "attribute": "c", "value": "Brasil" },
    { "attribute": "st", "value": "PJE" },
    { "attribute": "l", "value": "Sao Paolo" },
    { "attribute": "ou", "value": "Development" }
  ],
  "hashType": "SHA384",
  "keyLength": 2048,
  "keyType": "RSA",
  "provider": "CA_BRASIL"
}

Response

{
  "message": "Operation finalized successfully",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "requestCode": "P775W98SSW4Z1774PMZU",
    "csr": "MIIDYzCCAksCAQAwADCCASIwDQ..."
  }
}

---

Finalização

Finalizar a emissão

Conclui o processo de emissão ou renovação usando o requestCode obtido na criação do CSR.

PUT /raapi/v1/csr/finalize

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Content-Type	application/json

Body

{
  "dataInB64": "string",
  "requestCode": "string"
}

Campo	Tipo	Obrigatório	Descrição
dataInB64	string	Sim	Dados adicionais codificados em Base64, se exigidos pelo provedor.
requestCode	string	Não	Identificador da solicitação obtido na chamada a POST /raapi/v1/csr/create.

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "idCertificate": 0,
    "thumbprint": "string",
    "csrAuditDataValues": {}
  }
}

Campo	Descrição
data.idCertificate	Identificador do certificado emitido na Redtrust.
data.thumbprint	Thumbprint do certificado emitido.
data.csrAuditDataValues	Dados de auditoria do processo de criação do CSR.