API

Utiliser l’API

Tout ce que fait le tableau de bord, via la même API REST — depuis la CI, un script ou un panneau.

Tout ce que fait le tableau de bord, il le fait via la même API REST que vous pouvez appeler vous-même. Cette section traite de l’appeler sans session de navigateur — depuis la CI, un script, ou le panneau d’un hébergeur.

L’API est servie par votre propre instance, sous /api à l’URL où vous joignez le tableau de bord. Il n’y a pas d’API hébergée par DockBoard en intermédiaire : vos clés, vos données et vos requêtes ne quittent jamais votre serveur.

BASH

curl -H "Authorization: Bearer $DOCKBOARD_API_KEY" \
  https://panel.example.com/api/applications

Par où commencer

Authentification: Jetons de session contre clés API, frapper une clé, et ce qu’une clé ne pourra jamais faire.
Scopes: Ce que chaque scope atteint, les jokers, et les deux plafonds auxquels une clé répond.
Déployer depuis la CI: Un workflow complet qui déploie et attend le résultat.
Erreurs: Ce que signifie chaque code de statut, et comment exploiter les clés dans la durée.
Référence: Chaque endpoint, paramètre et corps de requête, généré depuis l’API elle-même.

La forme de l’API

JSON en entrée, JSON en sortie. Envoyez Content-Type: application/json sur toute requête avec un corps.
Les ressources sont adressées par identifiant opaque — /api/applications/:id, /api/deployments/:id. Les identifiants sont stables ; les slugs ne le sont pas.
Les erreurs sont des codes HTTP avec un corps JSON portant statusCode et message. Voir erreurs.
Les opérations longues — déploiement, restauration — répondent immédiatement avec un enregistrement que vous interrogez ensuite. Rien ne bloque pendant des minutes.

Une interface Swagger interactive est également servie sur /api/docs de votre propre instance. Elle est désactivée en production sauf si vous définissez SWAGGER_PUBLIC — la référence ici en est la copie publique.

L’autre API

Tout ce qui précède concerne l’API de votre instance. Séparément, ce site expose une petite API de licence servant à activer une licence et envoyer des heartbeats. Vous l’appelez rarement à la main — DockBoard s’en charge — mais elle est documentée pour les hébergeurs qui automatisent leurs installations.