|
Dans cet article : |
Présentation des API
Vous souhaitez interagir avec la plateforme de manière automatisée afin de consulter, créer ou mettre à jour certaines données (CRA, frais…) ? Des API sont à votre disposition pour vous aider à les automatiser.
Leur usage est conçu pour fonctionner dans le strict prolongement de l’application.
Les principes sont simples :
L’API utilise les mêmes mécanismes de sécurité que l’application.
-
Les droits sont définis par utilisateur ou par rôle, exactement comme dans l’interface.
Toute modification de droit dans l’interface s’applique immédiatement à l’API
Révoquer les accès d’un utilisateur bloque également ses accès par API
L’API donne accès uniquement aux actions et aux données déjà autorisées dans l’interface.
Exemples d’usage
Un consultant autorisé à saisir uniquement ses propres frais dans l’application pourra, via l’API associée à son compte, créer ses frais pour lui-même, sans possibilité de validation ou d’accès aux données d’autres utilisateurs.
Un partenaire ou sous-traitant pourra consulter et saisir via l’API uniquement les CRA de ses propres ressources, dans les mêmes limites que celles visibles dans l’application.
| ℹ️ A savoir : l’usage des API est englobée dans l’offre basique, vérifiez le niveau de licence auquel vous souhaitez la donner. |
Le catalogue est disponible avec les étapes d’intégration technique ici : APIs: Details.
Pré-requis d’utilisation des API
Pour pouvoir utiliser les API, il est nécessaire de :
Être habilité à utiliser les API
-
Générer une clé API pour l’utilisateur authentifié et habilité
Activer l’habilitation
Depuis la liste des habilitations, activer l’habilitation “Utiliser les API” à l’utilisateur et/ou au rôle ciblé
Générer la clé API à l’utilisateur habilité
Une fois l’habilitation active, l’utilisateur peut générer sa clé API depuis la page “Mon compte”
Une fois la clé générée, l’utilisateur peut la retrouver et la consulter depuis la page “Mon compte”
À noter : l’utilisateur peut à tout moment régénérer sa clé API à l’aide de l’icône de réinitialisation.
Cette action invalide automatiquement l’ancienne clé ; il sera donc nécessaire de mettre à jour la nouvelle clé dans toutes les automatisations ou intégrations existantes.
Vous pouvez désormais utiliser les endpoints accessibles pour vos usages.
Pour plus d’informations sur les endpoints disponibles ou le paramétrage technique, nous vous invitons à consulter la documentation dédiée : APIs: Details
|
ℹ️ Un projet d’intégration en tête ? Parlez-en à notre équipe support. Déjà connectés avec succès à : Pourquoi pas votre outil ? |
Paramétrage et utilisation de l’API
-
Paramétrage technique pour l’authentification d’un endpoint :
Dans le header d’appel, ajoutez une variable nommée Ocp-Apim-Subscription-Key
Renseignez comme valeur de clé API celle générée pour l’utilisateur
-
Si vous souhaitez tester les endpoints depuis Postman, configurez l’onglet authentification de votre endpoint comme suit :
Type d’authentification : API Key
Clé : Ocp-Apim-Subscription-Key
Value : votre clé API