Documentación API
Acceso API disponible para planes:
- Business
- Enterprise
Autenticación
Para usar la API, debes:
- Obtener un token de acceso desde tu cuenta
- Incluir el token en los encabezados de tus solicitudes:
Authorization: Bearer {token}
Lista de Dominios
GET /api/v1/domains
Obtiene una lista paginada de dominios para el usuario autenticado.
Encabezados
| Nombre | Valor | Descripción |
|---|---|---|
| Authorization | Bearer {token} | Token de autenticación para acceder a la API |
| Accept | application/json | Formato de respuesta esperado |
Respuesta
{
"data": [
{
"id": 1,
"domain": "example.com",
"valid": true,
"type": "EV",
"ssl_expires_at": "2024-12-31T23:59:59.000000Z",
"last_check_at": "2024-03-21T10:00:00.000000Z",
"created_at": "2024-03-21T10:00:00.000000Z",
"updated_at": "2024-03-21T10:00:00.000000Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Crear Dominio
POST /api/v1/domains
Crea un nuevo dominio para el usuario autenticado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| Dominio | Cadena de texto | URL del dominio (máx: 255 caracteres) |
Ejemplo de Solicitud
{
"domain": "example.com"
}
Respuesta
{
"data": {
"id": 1,
"domain": "example.com",
"valid": false,
"type": null,
"ssl_expires_at": null,
"last_check_at": null,
"created_at": "2024-03-21T10:00:00.000000Z",
"updated_at": "2024-03-21T10:00:00.000000Z"
}
}
Obtener Detalles del Dominio
GET /api/v1/domains/{id}
Obtiene los detalles de un dominio específico.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| ID | Entero | Identificador único del dominio |
Respuesta
{
"data": {
"id": 1,
"domain": "example.com",
"valid": true,
"type": "EV",
"ssl_expires_at": "2024-12-31T23:59:59.000000Z",
"last_check_at": "2024-03-21T10:00:00.000000Z",
"created_at": "2024-03-21T10:00:00.000000Z",
"updated_at": "2024-03-21T10:00:00.000000Z"
}
}
Actualizar Dominio
PUT /api/v1/domains/{id}
Actualiza un dominio existente.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| ID | Entero | Identificador único del dominio |
| Dominio | Cadena de texto | URL del dominio (máx: 255 caracteres) |
Ejemplo de Solicitud
{
"domain": "example.com"
}
Respuesta
{
"data": {
"id": 1,
"domain": "example.com",
"valid": true,
"type": "EV",
"ssl_expires_at": "2024-12-31T23:59:59.000000Z",
"last_check_at": "2024-03-21T10:00:00.000000Z",
"created_at": "2024-03-21T10:00:00.000000Z",
"updated_at": "2024-03-21T10:30:00.000000Z"
}
}
Eliminar Dominio
DELETE /api/v1/domains/{id}
Elimina un dominio existente.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| ID | Entero | Identificador único del dominio |
Respuesta
Código de estado: 204 (Sin Contenido)
Códigos de Error
| id | ID del dominio |
|---|---|
| 401 | No autenticado |
| 403 | Acceso no autorizado (plan incompatible) |
| 404 | Dominio no encontrado |
| 422 | Error de validación |