Waafir
Cette page est une traduction automatique en attente de relecture humaine. Elle peut contenir des erreurs.

API de la plateforme (/v1)

L'API de la plateforme est l'interface HTTP versionnée de Waafir. Utilisez-la pour consulter et gérer votre organisation depuis vos propres systèmes. Elle couvre votre équipe (inviter des membres, modifier leurs rôles, les retirer), les autorisations d'accès aux salles de données, les dossiers, les fichiers, les Q&R, le chat et les agents de salle de données, l'activité et l'engagement par contrepartie, ainsi que le suivi de portefeuille.

Il s'agit d'une surface distincte des serveurs MCP de Waafir, qui exposent la même plateforme aux clients IA sous forme d'outils. Les deux s'authentifient avec les mêmes jetons d'accès personnels.

URL de base

Chaque point de terminaison se trouve sous :

https://app.waafir.io/api/v1

La référence des points de terminaison les liste chacun par son chemin complet, par exemple GET /api/v1/team.

Votre premier appel

  1. Émettez un jeton. Dans Waafir, ouvrez Modules complémentaires → Configuration et émettez un jeton d'accès personnel. Un jeton read suffit pour commencer. Copiez la valeur, qui commence par waafir_pat_. Elle n'est affichée qu'une seule fois.
  2. Demandez qui vous êtes. GET /api/v1/session renvoie l'identité et l'organisation au nom desquelles agit le jeton. Utilisez-le pour vérifier qu'un jeton fonctionne avant de bâtir dessus :
curl -s https://app.waafir.io/api/v1/session \
  -H "Authorization: Bearer $WAAFIR_TOKEN"
{
  "orgId": "…",
  "userId": "…",
  "email": "you@example.com",
  "orgRole": "admin",
  "authMethod": "pat",
  "principalType": "user"
}

Un 401 signifie que le jeton est absent, mal saisi, expiré ou révoqué. Les autres refus comportent généralement un code lisible par une machine, expliqué sur la page des codes d'erreur. Certains n'en comportent aucun ; appuyez-vous donc toujours, à défaut, sur le statut HTTP.

Comment la référence est construite

Les pages points de terminaison et codes d'erreur sont générées à partir de l'arborescence de routes de la plateforme elle-même à chaque publication de ce site. Elles ne sont pas rédigées à la main. Une version de production les construit à partir du même commit que l'application ; elles listent donc les routes que sert cette version, avec la restriction de rôle et la portée de jeton qu'exige chaque point de terminaison, ainsi que les paramètres de requête qu'il accepte. Leurs listes d'erreurs sont un minimum connu, non exhaustif : un point de terminaison peut renvoyer des codes que le générateur ne voit pas ; traitez donc les erreurs non listées d'après le statut HTTP.

Versionnage

/v1 n'évolue que par ajouts au sein de sa version. Waafir peut ajouter des champs de réponse et des paramètres de requête facultatifs. Au sein de /v1, Waafir ne supprime pas un champ existant et n'en change pas le type, et ne supprime pas de point de terminaison. Un changement incompatible est publié sous un nouveau préfixe de version. Écrivez des clients qui ignorent les champs qu'ils ne reconnaissent pas.

Pour aller plus loin