Aller au contenu
AdiosDocumentation
Parcourir la documentation

API de démarrage rapide

Commencez par la santé de l’API, puis vérifiez votre jeton bearer et le contexte d’équipe.

Utiliser Authentification API pour les requêtes protégées. Les exemples utilisent vos propres ID de ressources et un jeton temporaire ; les exemples de réponses enregistrés sont synthétiques.

MéthodeCheminOpération
GET/v1/healthVérifier la santé de l’API
GET/v1/auth/meObtenir l'utilisateur actuel

Vérifier la santé de l’API

GET /v1/health

Vérifier si le processus API répond.

Authentification : publique ; aucun jeton bearer requis.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/health"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "status": "ok"
}

Obtenir l'utilisateur actuel

GET /v1/auth/me

Renvoie votre user_id, votre profil, vos équipes et team_data. Le script de réponse enregistre uniquement user_id dans l’environnement sélectionné. Définissez vous-même team_id sur l’équipe active de la CLI avant d’utiliser un jeton de diagnostic.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/auth/me" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.