Chargement de votre compte

Authentification

Toutes les requêtes, sauf le catalogue public, nécessitent une clé d’API envoyée comme jeton bearer.

Placez la clé dans l’en-tête Authorization de chaque requête. Les clés commencent par inker_live_.

HTTP
Authorization: Bearer inker_live_…
curl
curl https://api.inker.si/v1/account \
  -H "Authorization: Bearer $INKER_API_KEY"

Créer une clé

Créez des clés sur votre page de compte, dans la section Développeurs. La clé complète n’est affichée qu’une fois, juste après sa création : copiez-la à ce moment-là. inker n’en conserve qu’une empreinte et ne pourra jamais l’afficher à nouveau.

Permissions

Une clé ne peut appeler que les endpoints autorisés par ses permissions ; les autres répondent insufficient_scope. Ne donnez à chaque clé que ce dont elle a besoin.

PermissionAutorise
generateChiffrer, lancer et annuler des générations. Dépense des pièces.
readLister et lire les générations et les fichiers.
uploadsEnvoyer des fichiers d’entrée.
accountConsulter votre solde et vos limites.

Protéger vos clés

  • Appelez l’API depuis votre serveur. Ne mettez jamais une clé dans une page web, une application mobile ou un dépôt public.
  • Fixez un plafond mensuel de pièces pour chaque clé. Une fois ce montant dépensé sur un mois civil (UTC), les nouvelles générations répondent spend_cap_exceeded jusqu’au mois suivant.
  • Donnez une date d’expiration à vos clés (30, 90 ou 365 jours). Une clé expirée répond api_key_expired.
  • Révoquez une clé que vous n’utilisez plus ou qui a pu fuiter. Elle cesse de fonctionner immédiatement et répond api_key_revoked.

Les clés et les webhooks se gèrent uniquement depuis votre page de compte, une fois connecté : une clé d’API ne peut jamais créer de clés ni lire de secrets.