Authentification

Chaque appel à l'API porte un jeton d'API. Un jeton peut déployer ou seulement lire, être limité à une équipe et expirer.

Créer un jeton

  1. Connectez-vous à app.liftpad.app et ouvrez Account, puis API tokens (le tableau de bord est en anglais pour l'instant).
  2. Donnez-lui un nom reconnaissable (par exemple GitHub Actions).
  3. Choisissez l'équipe permise (All my teams, ou une seule équipe), l'accès (Deploy ou Read only) et l'expiration (90 days, 1 year ou No expiry).
  4. Appuyez sur Create token et copiez-le tout de suite : il commence par lp_ et n'est montré qu'une fois. Liftpad n'en garde qu'une empreinte.

Les jetons se créent seulement depuis une session du tableau de bord : un jeton ne peut jamais en créer un autre.

L'utiliser

curl -sS https://api.liftpad.app/v1/me -H "Authorization: Bearer $LIFTPAD_TOKEN"

La CLI le lit dans LIFTPAD_TOKEN ou dans ~/.liftpad.json. En intégration continue, gardez-le dans le coffre de secrets de la plateforme, jamais dans le dépôt.

Read ou deploy

AccèsCe qu'il peut faire
readVoir les sites, déploiements, vérifications, domaines, formulaires et envois, statistiques, équipes, crédits et le journal d'activité. Ne change jamais rien. Agit comme un observateur d'équipe.
deployTout ce que read peut faire, plus créer des sites, déployer, publier et revenir en arrière, mettre hors ligne, connecter et retirer des domaines, extraits de code, tests A/B et envois de formulaire. Agit au plus comme un développeur, même si son propriétaire est propriétaire ou administrateur.

Un jeton n'est jamais plus fort que la personne qui l'a créé : si elle est observatrice, le jeton ne fait que lire. Le jeton d'un membre facturation ne fait que lire.

Chaque opération de la référence indique l'accès minimal requis, comme son champ x-liftpad-scopes dans le document OpenAPI.

Ce qu'un jeton ne peut jamais faire

Ces appels répondent 403 avec "error": "session_required", sauf supprimer ou déplacer un site, qui répondent 403 avec "error": "forbidden" (un jeton agit au plus comme un développeur, et seul un propriétaire peut le faire). Faites-les dans le tableau de bord. Le champ x-liftpad-token-error de chaque opération du document OpenAPI donne le code exact.

Expiration et révocation

Erreurs possibles

HTTPerrorSens
401unauthorizedAucun jeton, un mauvais, un expiré ou un révoqué
403session_requiredCela exige le tableau de bord (voir plus haut)
403forbiddenVotre rôle, ou l'accès du jeton, est insuffisant (aussi un jeton qui supprime ou déplace un site)
404not_foundIntrouvable, ou invisible pour ce jeton
429rate_limitedPlus de 1200 requêtes par minute : attendez et réessayez