Cette documentation a été conçue pour permettre à nos partenaires ou à nos clients de type tiers gestionnaires (cabinets d’avocats, cabinets d’experts comptables, fonds d’investissement) d’intégrer de manière fluide et sécurisée les fonctionnalités clés d’Izikap au sein de leurs propres outils et plateformes.
A partir d’un compte « Tiers Gestionnaire » préalablement créé il est possible de générer des clés permettant l’authentification et donc le pilotage de l’application.
Dans cette documentation, vous trouverez toutes les informations nécessaires pour :
- Comprendre l’architecture et les principes de fonctionnement de l’API,
- Authentifier et sécuriser vos requêtes,
- Manipuler les entités principales (sociétés, registres, personnes, utilisateurs, etc.),
- Gérer les erreurs et assurer un bon suivi des intégrations.
A ce stade, les API exposées concernent particulièrement la gestion des sociétés et des registres de délibérations, mais le périmètre est amené à évoluer selon les besoins d’intégration.
Nous vous recommandons de lire attentivement cette documentation avant de débuter votre intégration. Notre équipe reste disponible pour toute question ou assistance technique.
1. Intégrer un SI Tiers avec Izikap
L’API Izikap permet une intégration simple et rapide entre un SI Tiers et Izikap afin de proposer aux utilisateurs une expérience globale entre les 2 solutions en apportant des fonctionnalités complémentaires Izikap au périmètre du SI Tiers.
Cette intégration permet de :
- Synchroniser les données entre les 2 solutions et d’éviter ainsi une double saisie et les erreurs éventuelles.
- Transférer les documents entre le SI Tiers et Izikap (les procès-verbaux par exemple)
- Disposer d’un accès unique depuis le SI Tiers en amont
2. Comment fonctionne l’API de Izikap ?
L’API de Izikap suit les conventions RESTful autant que possible. Elle accepte majoritairement le contenu JSON dans les requêtes (à l’exception de certains téléchargements de document qui attend un format binaire) et retourne du contenu JSON dans toutes ses réponses.
Les méthodes HTTP (GET, POST, PATCH, PUT, DELETE) déterminent le type d’opération sur la ressource. La ressource est identifiée par l’URL, qui est ciblée par la méthode.
La plupart des requêtes concernent le périmètre fonctionnel d’une société gérée par le tiers gestionnaire concerné.
3. Les environnements
L’API Izikap offre deux environnements :
- Environnement de bac à sable pour les explorations au sein de l’API Izikap.
- Environnement de production.
Ces deux environnements sont isolés et permettent aux développeurs d’expérimenter de nouveaux codes et fonctionnalités sur le bac à sable sans affecter l’environnement de production en direct.
|
Environnement |
Base URL |
|
Sandbox |
https://int.izikap.fr/api |
|
Production |
https://app.izikap.fr/api |
4. Création de votre compte
Création de votre profil tiers gestionnaire
Après inscription, la page d’enrôlement permet de créer son profil et de choisir l’offre Tiers gestionnaire.
Une fois la création de l’entreprise gestionnaire terminée, le menu est disponible et notamment l’accès à la page API.
Création d’une clé API
La clé API sert d’identifiant unique pour authentifier vos requêtes et accorder l’accès à l’API Izikap. Elle doit être incluse dans chaque requête API.
Seuls les utilisateurs Tiers gestionnaires ayant un rôle d’Administrateur peuvent créer des clés API.
L’utilisateur a la possibilité de créer jusqu’à 3 clés API actives simultanément.
Pour cela, il lui suffit seulement de saisir une description pour valider la génération de la clé.
Les clés générées sont affichées dans le tableau par ordre de création, de la plus récente à la plus ancienne.
Sur les clés affichées dans le tableau, 3 actions sont possibles :
- Visualiser
- Copier
- Révoquer : il est possible de révoquer une clé. La clé API devient alors inutilisable. La ligne correspondante dans le tableau est grisée, et plus aucune action n’est possible.
Une clé est créée au statut Actif. Une fois révoquée, elle passe au statut Inactif et n’est plus comptabilisée dans le compteur de clés actives.