API/API de l’organisation courante

API de l’organisation courante

Récupérez l’organisation associée à une clé API.

Récupérez l’organisation propriétaire de la clé API. Cet endpoint permet à une intégration d’identifier l’espace auquel la clé donne accès.

Endpoint

GET /api/v1/me

Authentification

Créez une clé API depuis les paramètres de l’organisation :

/orgs/{orgSlug}/settings/api-keys

Envoyez la clé dans l’en-tête x-api-key :

x-api-key: YOUR_API_KEY

L’authentification Bearer est également acceptée :

Authorization: Bearer YOUR_API_KEY

Réponse

ChampTypeDescription
organization.idstringIdentifiant de l’organisation
organization.namestringNom affiché de l’organisation
organization.slugstring | nullSlug utilisé dans les URL de l’application

Exemple JavaScript

const response = await fetch("https://api.yaoka.fr/api/v1/me", {
  headers: {
    "x-api-key": process.env.YAOKA_DOC_API_KEY!,
  },
});

if (!response.ok) {
  throw new Error(`Échec de l’API organisation : ${response.status}`);
}

const data = await response.json();

Erreurs

StatutDescription
401Clé absente, invalide, expirée ou limitée
404L’organisation associée à la clé n’existe plus
500Erreur interne du serveur