Authentifier vos requêtes à l’API Amply

Chaque requête à l’API Amply doit être authentifiée avec une clé API transmise comme jeton Bearer. Les clés sont associées à un projet et donnent accès à l’ensemble de ses ressources.

Générer une clé API

Vous connecter au tableau de bord

Rendez-vous sur pro.amply-app.com et connectez-vous à votre compte.

Ouvrir les réglages du projet

Sélectionnez votre projet, puis ouvrez Paramètres → API.

Générer une clé

Cliquez sur Générer une clé API.

Copier immédiatement la clé

Copiez la clé dès son affichage. Elle n’est affichée qu’une fois et ne pourra pas être récupérée ensuite.

Conserver la clé en sécurité

Enregistrez la clé dans une variable d’environnement ou un gestionnaire de secrets. Ne l’inscrivez jamais directement dans le code de votre application.

N’enregistrez jamais votre clé API dans un dépôt de code et ne la partagez pas publiquement. Toute personne qui la possède peut accéder aux contenus du projet. Si la clé est exposée, révoquez-la immédiatement et générez-en une nouvelle.

Utiliser votre clé API

Transmettez la clé comme jeton Bearer dans l’en-tête Authorization de chaque requête. cURL

curl https://api.amply-app.com/v1/events \
  -H "Authorization: Bearer YOUR_API_KEY"

JavaScript / Node.js

const response = await fetch('https://api.amply-app.com/v1/events', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

Remplacez YOUR_API_KEY par la clé générée dans le tableau de bord.

Révoquer une clé API

Vous pouvez invalider une clé à tout moment, notamment si elle a été exposée :

Dans le tableau de bord du projet, ouvrez Paramètres → API.
Retrouvez la clé concernée.
Cliquez sur Révoquer.

La révocation est immédiate. Une requête utilisant cette clé reçoit ensuite une réponse 401 Unauthorized.

Erreurs d’authentification

L’API distingue les erreurs d’authentification et d’autorisation :

Code HTTP	Signification
`401 Unauthorized`	La clé API est absente, mal formée ou révoquée. Vérifiez la clé transmise dans l’en-tête `Authorization`.
`403 Forbidden`	La clé est valide, mais l’action n’est pas autorisée. La fonctionnalité demandée n’est généralement pas disponible avec votre offre.

Généralités

Ressources

broadcastEvent resource

broadcastNetworkingForm resource

media resource

broadcastContact resource

broadcastCategory resource

broadcastClient resource

broadcastDiffuser resource

broadcastCampaign resource

broadcastArticle resource

broadcast resource

broadcastHost resource

broadcastInterestPoint resource

broadcastMap resource

broadcastMember resource

broadcastPage resource

revision resource

broadcastSession resource

workflow resource

workflowRun resource

font resource

Générer une clé API

Utiliser votre clé API

Révoquer une clé API

Erreurs d’authentification

​Générer une clé API

​Utiliser votre clé API

​Révoquer une clé API

​Erreurs d’authentification

Générer une clé API

Utiliser votre clé API

Révoquer une clé API

Erreurs d’authentification