Authentification

L'accès à la Partner API nécessite une authentification au moyen de clés secrètes API. Générez et gérez vos clés depuis la Partner Console.

Les clés API constituent vos identifiants d'accès aux ressources partenaires. Chaque clé dispose d'un accès restreint à des données d'organisation spécifiques et peut être désactivée instantanément si nécessaire.

Manipulez vos clés API avec précaution : elles donnent un accès complet à votre compte ! N'exposez jamais ces clés dans des dépôts publics, des applications côté client ou tout autre endroit où elles pourraient être compromises.

Authentifiez les requêtes avec l'authentification HTTP Basic en transmettant votre clé API comme nom d'utilisateur. Laissez le mot de passe vide.

L'API n'accepte que les connexions HTTPS sécurisées. Les requêtes HTTP non chiffrées sont rejetées, de même que toute requête dépourvue d'identifiants d'authentification valides.

Exemple de requête

curl https://partner-api.performancehub.co/partner/v1/organisations \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# The colon prevents curl from asking for a password.

Vérifier la clé secrète

curl https://partner-api.performancehub.co/partner/v1/auth/ping \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# Returns { "message": "You are successfully authorised as <PartnerName>" }