Intégration
      Revenir à l'accueil
      1. Centre d'aide
      2. Intégration

      Intégration API

      Le logiciel RGPD expose un ensemble d’API afin de permettre une intégration fine au sein des applications clientes. Ce guide s’adresse à des développeurs et/ou chefs de projet et présente la démarche d’intégration ainsi que les différents prérequis.

      Principe

      1. Obtention des clés d’API

      2. Intégration en environnement de sandbox

      3. Activation en production

      Documentation OpenAPI

      Les API sont exposées au format json/Rest. Les contrats d’interface et schémas de données sont documentés au format OpenAPI 3.0 et sont disponibles à l’adresse suivante :

      https://sandbox.qa.dld.dev/api/v1/api-docs 

      Ce document technique est protégé. Il est nécessaire de s'être préalablement authentifié sur le logiciel à l’adresse https://sandbox.qa.dld.dev/ avant de pouvoir y accéder.

      Ces contrats d’interface sont utilisables pour générer des modèles de requêtes/réponses dans tout programme supportant le format OpenAPI (ex : https://redocly.github.io/redoc/)

      Sécurisation des API

      Les API sont protégées par un système de clés d’API. Une clé est composée d’une AccessKey et d’une SecretKey. Veuillez-vous rapprocher du support Data Legal Drive pour obtenir vos jeux de clés via le Centre d’aide, demande de support technique.

      Une clé d’API est directement associée à une entité unique et ne permet de travailler que sur le périmètre de cette entité.

      La fourniture des informations d’authentification se fait par le passage d’un header http respectant le format suivant :

      x-api-key: accessKey={ACCESS_KEY};secretKey={SECRET_KEY}

      Les clés sont spécifiques pour chaque environnement.

      Révocation des clés

      En cas de compromission de vos clés d’API, veuillez en informer immédiatement le support Data Legal Drive afin que vos clés soient révoquées et de nouvelles clés générées.

      Environnements

      Deux environnements sont mis à disposition :

      1. Un environnement d’intégration à des fins de test et d’implémentation
        https://sandbox.qa.dld.dev/
        Les données de cet environnement ne sont ni sauvegardées ni répliquées. Les bases de données peuvent être réinitialisées par les équipes techniques de Data Legal Drive à tout moment.

      2. Un environnement de production :
        https://dld.datalegaldrive.com