Documentation API
Accès API disponible pour les plans :
- Business
- Enterprise
Authentification
Pour utiliser l'API, vous devez :
- Obtenir un token d'accès depuis votre compte
- Inclure le token dans l'en-tête de vos requêtes :
Authorization: Bearer {token}
Liste des domaines
GET /api/v1/domains
Récupère la liste paginée des domaines de l'utilisateur authentifié.
En-têtes
| Nom | Valeur | Description |
|---|---|---|
| Authorization | Bearer {token} | Token d'authentification pour accéder à l'API |
| Accept | application/json | Format de réponse attendu |
Réponse
{
"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
}
}
Création d'un domaine
POST /api/v1/domains
Crée un nouveau domaine pour l'utilisateur authentifié.
Paramètres
| Nom | Type | Description |
|---|---|---|
| Domaine | Chaîne de caractères | URL du domaine (max: 255 caractères) |
Exemple de requête
{
"domain": "example.com"
}
Réponse
{
"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"
}
}
Détails d'un domaine
GET /api/v1/domains/{id}
Récupère les détails d'un domaine spécifique.
Paramètres
| Nom | Type | Description |
|---|---|---|
| ID | Entier | Identifiant unique du domaine |
Réponse
{
"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"
}
}
Mise à jour d'un domaine
PUT /api/v1/domains/{id}
Met à jour un domaine existant.
Paramètres
| Nom | Type | Description |
|---|---|---|
| ID | Entier | Identifiant unique du domaine |
| Domaine | Chaîne de caractères | URL du domaine (max: 255 caractères) |
Exemple de requête
{
"domain": "example.com"
}
Réponse
{
"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"
}
}
Suppression d'un domaine
DELETE /api/v1/domains/{id}
Supprime un domaine existant.
Paramètres
| Nom | Type | Description |
|---|---|---|
| ID | Entier | Identifiant unique du domaine |
Réponse
Code de statut : 204 (No Content)
Codes d'erreur
| id | ID du domaine |
|---|---|
| 401 | Non authentifié |
| 403 | Accès non autorisé (plan incompatible) |
| 404 | Domaine non trouvé |
| 422 | Erreur de validation |