Passer au contenu principal
L’API Hyperline nécessite soit une clé API, soit un jeton d’accès pour identifier et autoriser les appels. Les clés API sont associées à un seul compte Hyperline, et un jeton d’accès représente un accès délégué à un compte spécifique (utilisé pour les applications tierces). Vous pouvez avoir plusieurs jetons ou clés à tout moment. Ces jetons sont capables de s’authentifier auprès d’Hyperline et d’effectuer des actions sur votre compte. Il est donc important de les garder en sécurité comme vous le feriez avec un mot de passe.

​
Gérer les clés API

​
Comment générer une clé API

Générer une clé API est très simple et vous permet d’utiliser l’API Hyperline ou des intégrations telles que Zapier. En tant qu’administrateur Hyperline :
  1. Allez dans les Paramètres de votre espace de travail, section API
  2. Cliquez sur + New API key
  3. Ajoutez un nom pour cette clé et sélectionnez les scopes appropriés (dans la plupart des cas, vous aurez besoin des accès lecture/écriture)
  1. Copiez la clé et conservez-la dans un endroit sûr ; vous ne pourrez plus la consulter ultérieurement dans Hyperline
Les clés API sont préfixées par prod_ ou test_ afin de les identifier et de les distinguer facilement entre les environnements.

​
Utilisation du jeton d’authentification

Les clés API ou les jetons d’accès doivent être fournis à chaque appel API, spécifiés dans l’en-tête Authorization après un préfixe Bearer. Toutes les requêtes utilisent HTTPS. Par exemple : 
curl -H "Authorization: Bearer <API key or access token>" https://api.hyperline.co/v1/customers
Nous prenons également en charge l’authentification HTTP Basic, où le username est la clé API et le password est laissé vide, mais nous recommandons l’authentification Bearer car elle est plus simple à déboguer.

​
Garder vos données en sécurité

Vos clés API doivent être traitées comme des informations hautement sensibles — pensez à un jeton comme à un mot de passe. Vous ne devez donner des jetons qu’à des services en lesquels vous avez entière confiance. En cas de fuite, les jetons pourraient être utilisés à des fins malveillantes — ils peuvent donner à quelqu’un accès à toutes vos données Hyperline. Si vous suspectez qu’un jeton a été compromis, révoquez-le et remplacez-le par un nouveau.
Les jetons ne doivent jamais être partagés avec les équipes de support ni avec vos clients.

​
Révoquer une clé

Les administrateurs de l’espace de travail peuvent révoquer définitivement les jetons depuis les Paramètres API dans Hyperline. Pour révoquer un jeton, cliquez sur l’icône … à la ligne du nom de la clé, puis sur Delete pour le supprimer définitivement. Une clé supprimée ne peut pas être récupérée.