Développeurs

Référence de l’API

Créez et gérez vos sites depuis votre code.

L’API de Droply vous permet de créer des sites et de lancer des déploiements depuis vos propres scripts et depuis les intégrations (la GPT Action de ChatGPT, n8n, VS Code et l’extension Chrome passent toutes par elle). La spécification lisible par machine est publiée à l’adresse /api/v1/openapi.json (OpenAPI 3.1).

URL de base

https://droply.host/api/v1

Authentification

Créez un jeton d’accès personnel dans votre tableau de bord, sous API tokens (jetons d’API), puis envoyez-le comme jeton Bearer dans chaque requête. L’accès à l’API nécessite une offre payante.

Authorization: Bearer YOUR_TOKEN

Pour vérifier un jeton à tout moment :

curl https://droply.host/api/v1/user \
  -H "Authorization: Bearer YOUR_TOKEN"

Les jetons créés sur la page API tokens disposent du Full access (accès complet), qu’il faut pour modifier les réglages d’un site, supprimer un site, publier un brouillon ou revenir à une version précédente. Les jetons limités au déploiement, que les extensions de navigateur et d’éditeur créent quand vous vous y connectez, peuvent créer des sites et déployer, rien de plus.

Créer un site

Réserve un sous-domaine, servi à l’adresse <subdomain>.droply.id. Si vous omettez subdomain, Droply en choisit un qui est libre.

curl -X POST https://droply.host/api/v1/sites \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subdomain":"my-portfolio","name":"My Portfolio"}'

Retrouver un site

Les identifiants de site et de déploiement sont des UUID. Pour trouver l’identifiant d’un site sans parcourir toute la liste, filtrez par sous-domaine, ou par l’adresse que tape un visiteur (son adresse Droply ou un nom de domaine personnalisé connecté) :

curl "https://droply.host/api/v1/sites?subdomain=my-portfolio" \
  -H "Authorization: Bearer YOUR_TOKEN"

curl "https://droply.host/api/v1/sites?host=www.example.com" \
  -H "Authorization: Bearer YOUR_TOKEN"

Déployer

Envoyez un fichier (un fichier HTML, le ZIP d’un site statique, un PDF ou une image) ou du HTML brut. L’extension du fichier détermine la façon dont il est servi : envoyez-le donc sous son vrai nom. Le traitement est asynchrone : l’appel répond 202 avec un déploiement dont vous pouvez suivre l’état.

# Envoyer le ZIP d’un site statique
curl -X POST https://droply.host/api/v1/sites/SITE_ID/deployments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "[email protected]"

# …ou publier du HTML brut (12 Mo maximum ; au-delà, envoyez la page sous forme de fichier)
curl -X POST https://droply.host/api/v1/sites/SITE_ID/deployments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"html":"<!doctype html><h1>Hello</h1>"}'

Suivre l’état d’un déploiement

Interrogez l’API jusqu’à ce que status passe à live (la réponse contient alors live_url) ou à failed (voir error_message).

curl https://droply.host/api/v1/deployments/DEPLOYMENT_ID \
  -H "Authorization: Bearer YOUR_TOKEN"

Brouillons, publication et retour arrière

Ajoutez draft à un déploiement pour enregistrer la version sans la mettre en ligne : elle est traitée et analysée, puis attend à l’état staged pendant que le site continue de servir la version précédente. Publiez-la quand vous le souhaitez, ou remettez en ligne une version antérieure. Les deux appels répondent 202 tant que la modification est en file d’attente ; interrogez le déploiement jusqu’à ce qu’il soit live.

# Enregistrer un brouillon (en multipart, on envoie draft=1)
curl -X POST https://droply.host/api/v1/sites/SITE_ID/deployments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "[email protected]" -F "draft=1"

# Le publier
curl -X POST https://droply.host/api/v1/deployments/DEPLOYMENT_ID/publish \
  -H "Authorization: Bearer YOUR_TOKEN"

# Revenir à une version précédente (n’importe quel déploiement remplacé)
curl -X POST https://droply.host/api/v1/deployments/DEPLOYMENT_ID/rollback \
  -H "Authorization: Bearer YOUR_TOKEN"

Mot de passe et expiration automatique

Seuls les champs envoyés sont modifiés. password_protected: false retire le mot de passe ; expires_at accepte une date et une heure ISO 8601 avec leur décalage horaire, ou null pour supprimer l’expiration.

curl -X PATCH https://droply.host/api/v1/sites/SITE_ID \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"password":"s3cret-preview","expires_at":"2026-12-01T18:00:00Z"}'

Endpoints

  • GET /user : le compte authentifié et son offre
  • GET /sites : liste vos sites (filtre possible avec subdomain ou host)
  • POST /sites : crée un site
  • GET /sites/check?subdomain= : indique si un sous-domaine est libre
  • GET /sites/{site} : renvoie un site
  • PATCH /sites/{site} : modifie son nom, son mot de passe ou son expiration automatique (Full access)
  • DELETE /sites/{site} : supprime un site (Full access). Un site placé dans un espace protégé contre la suppression accidentelle ne peut être supprimé que depuis le tableau de bord. Un site retiré, ou dont une version est conservée pour un contrôle de sécurité, répond 409.
  • POST /sites/{site}/deployments : déploie (fichier ou html, éventuellement en brouillon)
  • GET /sites/{site}/deployments : liste les déploiements d’un site
  • GET /deployments/{deployment} : état du déploiement
  • POST /deployments/{deployment}/retry : relance un déploiement en échec
  • POST /deployments/{deployment}/publish : publie un brouillon (Full access)
  • POST /deployments/{deployment}/rollback : remet en ligne une version précédente (Full access)

Erreurs et limites

  • 401 : jeton absent ou invalide.
  • 403 : votre offre n’inclut pas l’accès à l’API ou à cette fonctionnalité, ou le jeton n’a pas le droit d’effectuer cette action (certaines actions exigent un jeton Full access).
  • 404 : la ressource n’existe pas ou ne vous appartient pas.
  • 409 : cette action ne s’applique pas à cette version (par exemple, publier une version qui n’est pas un brouillon).
  • 413 : l’import dépasse ce qu’une seule requête peut transporter (100 Mo).
  • 422 : la validation a échoué (un objet errors liste les champs en cause).
  • 429 : limite de requêtes dépassée. Les requêtes sont limitées par jeton, et la publication de brouillons comme les retours arrière sont plafonnés à 30 par heure et par compte. Attendez le nombre de secondes indiqué dans l’en-tête Retry-After.

Voir aussi