Aller au contenu

Overview

Lisez et écrivez vos espaces, vos inboxes et vos messages Facteur depuis un script ou une suite de tests, sans navigateur.

Chaque requête porte une clé d’API dans l’en-tête Authorization : Authorization: Bearer fk_.... Une personne crée la clé dans l’application Facteur et ne la voit qu’une fois. Une clé détient une ou plusieurs des permissions ws:read et ws:write (le contenu d’un espace : ses inboxes et ses messages) et org:read et org:write (la structure de l’organisation : ses espaces). Écrire inclut lire à l’intérieur d’une famille, et les deux familles ne s’impliquent jamais. Une clé n’atteint que les espaces qu’on lui a donnés : tout autre répond 404, comme s’il n’existait pas.

Chaque opération ci-dessous nomme la permission qu’elle exige et les refus qu’elle peut répondre, chacun avec son code. Les guides sont dans le portail des développeurs, dont GET /.well-known/oauth-protected-resource donne l’adresse sous resource_documentation.

Information

  • OpenAPI version: 3.1.0

Une clé d’API : Authorization: Bearer fk_....

Security scheme type: http