Documentation de l'API ⋅ Documentation de Plume

Obtenir un jeton API

Pour accéder à l'API, vous devez enregistrer votre application et obtenir un jeton. Pour ce faire, utilisez l'API /api/v1/apps (accessible sans jeton) pour créer une nouvelle application. Stockez le résultat quelque part pour l'utiliser ensuite.

Envoyez ensuite une demande à /api/v1/oauth2, avec les paramètres GET suivants :

client_id, votre ID client.
client_secret, votre clé cliente secrète.
scopes, les espaces auxquels vous souhaitez accéder. Ils sont séparés par +, et peuvent soit être read (lecture global), write (écriture globale), read:SCOPE (lu seulement dans SCOPE), ou write:SCOPE (écrire uniquement dans SCOPE).
username le nom d'utilisateur (pas l'email, le nom d'affichage ni le nom complet) de l'utilisateur qui utilise votre application.
password, le mot de passe de l'utilisateur.

Plume répondra avec quelque chose de similaire à :

{
  "token": "<YOUR TOKEN HERE>"
}

Pour authentifier vos requêtes, vous devez placer ce jeton dans l'en-tête Authorization :

Authorization: Bearer <YOUR TOKEN HERE>