✒️
Documentation API Engagement
API Reference
API Reference
  • API REFERENCE
    • Introduction
    • Authentification
    • Errors
  • MISSION (/mission)
    • Récupérer des missions
    • Rechercher dans les missions
    • Récupérer une mission avec l'identifiant
  • MES MISSIONS (/mymission)
    • Récupérer vos missions
    • Récupérer votre mission avec l'identifiant de la mission
    • Récupérer les statistiques d'une mission
  • PERFORMANCE (/view)
    • Récupérer des statistiques sur vos missions
  • DIFFUSEUR (/publisher)
    • Récupérer la liste de mes partenaires diffuseurs
    • Récupérer les informations d'un partenaire diffuseur avec son identifiant
  • MES ORGANISATIONS (/myorganization)
    • Récupérer la liste des partenaires diffuseurs pour une organisation
    • Modifier les partenaires diffuseurs d'une organisation
  • Organisation (/organization)
    • Récupérer les organisations
Powered by GitBook
On this page
  1. API REFERENCE

Authentification

Cette page détaille comment utiliser vos clés API

L'API Engagement utilise des clés API pour authentifier les requêtes. Vous pouvez consulter et gérer votre clé API dans le tableau de bord.

La création d'une clé API nécessite l'aide d'un chargé de déploiement avec qui vous êtes en contact. Cette personne pourra générer cette clé pour vous depuis le tableau de bord.

Votre clé API confèrent de nombreux privilèges, il est donc essentiel de les garder sécurisées ! Ne partagez jamais vos clés API secrètes dans des espaces accessibles au public tels que GitHub, du code côté client, etc.

Pour vous authentifier, vous devez ajouter un en-tête Authorization avec le contenu suivant :

x-api-key : Bearer xxxxxxxx_xxxx_xxxx_xxxx_xxxxxxxxxxxx

où xxxxxxxx_xxxx_xxxx_xxxx_xxxxxxxxxxxx est votre clé API.

Toutes les requêtes API doivent être effectuées via HTTPS. Les appels effectués en HTTP simple échoueront. Les requêtes API sans authentification échoueront également.

PreviousIntroductionNextErrors

Last updated 3 months ago