Documentation API - Authentification

Vue d'ensemble

L'API Diamy utilise des clés API pour authentifier les requêtes. Pour accéder à l'API, vous devez inclure votre clé API dans chaque requête. Toutes les requêtes API doivent être effectuées via HTTPS. Les requêtes sans authentification ou via HTTP simple seront rejetées.

Important

Vos clés API permettent d'effectuer de nombreuses actions dans votre compte Diamy. Gardez-les en sécurité !

Ne partagez pas vos clés API dans des dépôts de code publics ou dans du code client accessible.

Obtenir votre clé API

Pour obtenir votre clé API :

Connectez-vous à votre compte Diamy
Accédez à Paramètres > API
Cliquez sur Générer une nouvelle clé API

Vous pouvez générer plusieurs clés API pour différentes intégrations et les révoquer individuellement si nécessaire.

Authentification par clé API

Il existe deux façons d'authentifier vos requêtes API :

1. En-tête d'autorisation (recommandé)

Incluez votre clé API dans l'en-tête Authorization de vos requêtes HTTP :

Authorization: Bearer votre_clé_api

2. Paramètre de requête

Vous pouvez également inclure votre clé API en tant que paramètre de requête api_key :

https://api.diamy.io/v1/calls?api_key=votre_clé_api

Note

L'utilisation de l'en-tête d'autorisation est préférable car elle évite que votre clé API n'apparaisse dans les journaux de serveur ou les historiques de navigation.

Environnements API

Diamy propose deux environnements API :

Environnement	URL de base	Description
Production	`https://api.diamy.io/v1`	Environnement de production pour les applications en direct
Sandbox	`https://api-sandbox.diamy.io/v1`	Environnement de test pour le développement et les tests

Chaque environnement nécessite sa propre clé API. Les clés de production ne fonctionneront pas dans l'environnement sandbox et vice versa.

Sécurité et bonnes pratiques

Stockez vos clés API de manière sécurisée, idéalement dans des variables d'environnement ou un gestionnaire de secrets
Utilisez des clés API différentes pour chaque intégration ou service
Accordez le minimum de privilèges nécessaires à chaque clé API
Faites tourner régulièrement vos clés API, surtout en cas de suspicion de compromission
Surveillez l'utilisation de vos clés API via le tableau de bord Diamy

Authentification OAuth (Bientôt disponible)

Diamy prévoit de prendre en charge l'authentification OAuth 2.0 pour les intégrations d'applications tierces. Cette fonctionnalité permettra à vos utilisateurs d'autoriser votre application à accéder à leurs données Diamy sans partager leurs identifiants.

Restez informés des mises à jour de notre documentation pour plus de détails.

Documentation