Referencia de endpoints de la RA API

Esta página documenta todos los endpoints de la RA API. Para información sobre autenticación y el formato de respuesta, consulta la visión general de la RA API.

Autenticación

Iniciar sesión

Autentica a un usuario con sus credenciales y devuelve un token de acceso y un token de refresco.

POST /raapi/v1/auth/login

Parámetro	Valor
Autenticación	No requerida
Content-Type	application/json

Body

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

Respuesta

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

---

Refrescar el token

Obtiene un nuevo token de acceso usando un token de refresco válido.

PUT /raapi/v1/auth/refresh-token

Parámetro	Valor
Autenticación	No requerida
Content-Type	application/json

Body

{
  "refreshToken": "string"
}

Respuesta

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

---

Cerrar sesión

Invalida el token de refresco del usuario autenticado.

DELETE /raapi/v1/auth/logout

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Body	—

Respuesta

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

---

Generación del CSR

Crear el CSR

Genera un par de claves en el servidor y devuelve un CSR junto con un requestCode para completar la emisión o renovación.

POST /raapi/v1/csr/create

Parámetro	Valor
Autenticación	Authorization: Bearer TU_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	Requerido	Descripción
dn	array	Sí	Lista de atributos del Distinguished Name (DN). Cada elemento tiene un attribute (por ejemplo, cn, o, c) y un value.
hashType	string	Sí	Algoritmo de hash. Por ejemplo: SHA256, SHA384, SHA512.
keyLength	integer	Sí	Longitud de la clave en bits. Por ejemplo: 2048, 4096.
keyType	string	Sí	Tipo de clave. Por ejemplo: RSA, DSA.
provider	string	Sí	Nombre del proveedor de certificados (CA) configurado en Redtrust.
requestCode	string	No	Identificador de solicitud. Opcional en la primera emisión.
info	object	No	Información adicional específica del proveedor.
groupIds	array	No	Lista de identificadores de grupos de certificados a los que se asigna el certificado.
thumbprintToRenew	string	No	Thumbprint del certificado que se renueva. Incluye este campo solo en operaciones de renovación.

Respuesta

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

Campo	Descripción
data.requestCode	Identificador de la solicitud. Debes incluirlo en la llamada a PUT /raapi/v1/csr/finalize.
data.csr	CSR generado codificado en Base64.

Ejemplo de emisión

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..."
  }
}

---

Finalización

Finalizar la emisión

Completa el proceso de emisión o renovación usando el requestCode obtenido en la creación del CSR.

PUT /raapi/v1/csr/finalize

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Content-Type	application/json

Body

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

Campo	Tipo	Requerido	Descripción
dataInB64	string	Sí	Datos adicionales codificados en Base64, si los requiere el proveedor.
requestCode	string	No	Identificador de la solicitud obtenido en la llamada a POST /raapi/v1/csr/create.

Respuesta

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

Campo	Descripción
data.idCertificate	Identificador del certificado emitido en Redtrust.
data.thumbprint	Thumbprint del certificado emitido.
data.csrAuditDataValues	Datos de auditoría del proceso de creación del CSR.