La API REST de Esadax proporciona varios puntos finales para administrar certificados. Estos puntos finales le permiten recuperar, crear, actualizar y eliminar certificados asociados a su cuenta o equipo.
A. Panorama general
La API de Certs le permite interactuar con los registros de certificados almacenados en el sistema Esadax. Cada certificado se puede identificar por su id único y está asociado a un equipo específico. La API admite varias operaciones, como obtener un certificado por ID, emitir nuevos certificados, actualizar los existentes y eliminarlos.
Endpoints
1. Aplicación. Obtener Cert por ID
- Método: GET
- URL:
/v7/certs/{id} - Path Parameter:
id(requerido) - Parámetros de la consulta:
slug,teamId - Respuesta: Devuelve los detalles del certificado, incluidos
autoRenew,cns,createdAt,expiresAtyid.
2. Emitir un nuevo certificado
- Método: POST
- URL:
/v7/certs - Parámetros de la consulta:
slug,teamId - Request Body: Contiene una matriz de cadenas de nombre común (CNS) bajo la clave
cns. - Respuesta: Devuelve los detalles del certificado recién creado.
3. Subir un Cert
- Método: PUT
- URL:
/v7/certs - Parámetros de la consulta:
slug,teamId - Request Body: Incluye
ca(Autoridad de Certificación),cert(contenido del certificado),key(clave privada), y opcionalmenteskipValidation. - Respuesta: devuelve los detalles del certificado actualizado.
4. Eliminar un certificado
- Método: BORRAR
- URL:
/v7/certs/{id} - Path Parameter:
id(requerido) - Parámetros de la consulta:
slug,teamId - Respuesta: Elimina el certificado especificado del sistema.
Autenticación
Todas las llamadas a la API requieren un token de autorización, que debe incluirse en los encabezados de la solicitud como Authorization: Bearer {token}.
Códigos de respuesta
La API utiliza códigos de estado HTTP estándar para indicar el éxito o el fracaso. Por ejemplo:
- 200 OK: Indica una operación exitosa.
- 400 Bad Request: Si hay un problema con los parámetros de la solicitud.
- 403 Prohibido: Cuando el usuario carece de los permisos necesarios para realizar la acción.
Esta documentación proporciona detalles completos sobre cómo interactuar con el sistema de gestión de certificados de Esadax a través de su API REST. Asegúrese de revisar los requisitos específicos de cada punto final antes de implementarlos en su aplicación.
