Qu'est-ce que l'API Publique d'Agicap ?

L'API Publique vous permet, ainsi qu'à vos intégrateurs ou partenaires, de développer des intégrations techniques avec Agicap. Elle vous permet d'automatiser l'échange de données entre applications, facilitant ainsi l'intégration avec vos outils existants.

Pourquoi utiliser l'API Publique ?

Voici quelques avantages immédiats de l'utilisation de l'API Publique :

Sécurité renforcée : Nos API sont protégées par un flux d'identification client. Chaque organisation doit générer ses propres identifiants depuis l'application Agicap avant de commencer à utiliser l'API. C'est plus sécurisé car chaque service utilise des identifiants uniques.
Performance accrue : Notre solution peut gérer jusqu'à 4000 requêtes par seconde, permettant à vos intégrations de s'adapter sans craindre de pannes d'API.
Cohérence : Nous avons défini des lignes directrices pour l'API d'Agicap afin de garantir que toutes nos API exposées aient des implémentations standardisées.

À long terme, l'API Publique permettra des cas d'utilisation qui n'étaient pas possibles avec notre précédente Open API :

Surveillance complète : Surveillez la consommation de l'API par les clients configurés et leurs points d'accès.
Capacités d'usurpation d'utilisateur : Autorisez les appels API en tant qu'utilisateur dans un système d'identification client, permettant des tâches automatisées comme l'attribution d'un utilisateur à une entité lorsqu'il est ajouté à votre Active Directory.

Comment commencer avec l'API Publique

1. Accédez à la documentation de l'API Publique

La documentation de l'API Publique est disponible sur https://api.agicap.com/. Vous y trouverez des informations détaillées sur la façon de faire des requêtes API.

2. Générez vos identifiants API

Seuls les utilisateurs Admin d'organisation peuvent générer des clés API depuis les Paramètres avancés dans l'application Agicap. Les autres utilisateurs peuvent voir les identifiants existants mais ne peuvent pas en générer de nouveaux ni supprimer les existants.

Pour générer des identifiants API :

Accédez aux Paramètres avancés de votre compte Agicap.
Sélectionnez Paramètres API.
Cliquez sur Générer de nouveaux identifiants.
Note : Pour des raisons de sécurité, le secret client ne sera affiché qu'une seule fois lors de la génération. Assurez-vous de le garder en sécurité.

👍 Il est recommandé d'utiliser un ensemble unique de clés API pour chaque outil, intégrateur ou partenaire.

3. Authentifiez vos requêtes API

L'authentification est gérée via des clés API et nécessite un jeton d'accès temporaire. Vous pouvez récupérer ce jeton en utilisant la requête d'authentification et vos clés API.

Chaque requête doit inclure ce jeton d'accès.

4. Effectuer des requêtes API

Les requêtes API sont organisées en domaines et produits :

Domaines API : Se réfèrent au contexte commercial général.
Produits API : Se réfèrent à des objets spécifiques ou à des ensembles d'objets liés avec lesquels interagir.

La plupart des requêtes sont effectuées pour récupérer des données pour une entreprise ou une entité donnée.

L'ID de l'organisation peut être récupéré depuis la page des paramètres API.
L'ID de l'entité peut être récupéré via la requête liste des entités.

Vous pouvez :

Récupérer des données d'Agicap pour mettre à jour vos outils.
Pousser, mettre à jour ou supprimer des données dans Agicap.

5. Explorez les points d'accès API

Visitez https://api.agicap.com/apis pour voir les points d'accès disponibles et les actions que vous pouvez effectuer via l'API Publique.

💡 Conseils

Gardez vos identifiants en sécurité : Votre secret client n'est affiché qu'une seule fois. Stockez-le en toute sécurité.
Utilisez des identifiants uniques : Générez des clés API distinctes pour chaque service ou intégration pour une meilleure sécurité.
Consultez la documentation : Référez-vous toujours à https://api.agicap.com/ pour les informations les plus à jour.

Q&R ❓

Quelle est la différence entre l'API Publique et l'Open API ?

Attention à ne pas confondre Open API et API Publique ; ce sont deux choses différentes :

Open API : Vous permet de créer des connexions Business et Bancaires (principalement via AFT) et est gérée par l'équipe d'intégration de données. Les points d'accès commencent par openapi.agicap.com.
API Publique : Vous permet d'envoyer et de récupérer diverses données d'Agicap de manière sécurisée et efficace. Les points d'accès commencent par api.agicap.com.

L'API Publique offre une sécurité, une performance et de nouvelles capacités améliorées non disponibles avec l'Open API.

Comment migrer de l'Open API à l'API Publique ?

Notre objectif est de faire passer tous les cas d'utilisation à l'API Publique. Nous contacterons les clients utilisant encore l'Open API une fois que tous les cas d'utilisation seront couverts sur l'API Publique.

Puis-je obtenir de l'aide pour configurer l'API Publique ?

Les clients sont censés être autonomes dans la configuration de l'API Publique en suivant les instructions sur le site public https://api.agicap.com/. Si vous avez besoin d'une assistance supplémentaire, veuillez nous le faire savoir.