API - Description

1. Introduction

1.1. Aperçu des API

Efalia Sign est une plateforme de signature en ligne et sur smartphones de contrats et documents de toutes natures.

Le service est accessible :

  • Sur le site internet https://www.contrat-prive.com/
  • Via des interfaces de programmation (API), qui permettent
    • d'automatiser des actions en masse (exemple: création de contrats)
    • d'insérer dans votre propre site internet les fonctions de signature et d'horodatage électronique de documents

Ce document présente les principales fonctionnalités disponibles en mode API, et quelques exemples d'utilisation.

L'utilisation des API est détaillée dans notre documentation technique en ligne, disponible sur https://www.contrat-prive.com/fr/product/api_doc

1.2. Plateformes

Les API sont disponibles sur :

  • sandbox.contrat-prive.com, la plateforme «bac à sable», permettant à tous nos clients de développer et tester les fonctionnalités mises à disposition
  • www.contrat-prive.com, la plateforme de production, pour les clients ayant souscrit à l'un des packs de jetons Efalia Sign éligibles (Pack 1K ou Pack 10K)

1.3. Accès aux API

Pour accéder aux API, vous devez disposer de 2 clés :

  • apiKey : clé privée d'accès aux API
  • apiUser : clé publique du compte déposant (appelé par la suite utilisateur)

Ces deux clés sont disponibles dans votre compte de déposant.

1.4. Limitation d'utilisations

Les limitations suivantes sont mises en place par défaut. Si vous souhaitez disposer de seuils plus élevés, merci de prendre contact avec les administrateurs Efalia Sign.

1.4.1. Plateforme Bac à sable

  • pas d'envoi réel de SMS - code valide pour les tests 0000
  • signature et horodatage factices des documents(filigrane test ajouté)
  • pour tester le paiement
    • vous pouvez utiliser ce numéro de CB pour payer les acomptes : 4706750000000009 avec n'importe quelle date d'expiration (dans le futur) et n'importe quel cryptogramme visuel (3 chiffres). Aucun compte ne sera vraiment débité.
    • vous pouvez utiliser n'importe quel RIB (il y en a un en exemple dans le message d'erreur de format). Aucun compte ne sera vraiment crédité.
  • En revanche, les notifications par e-mail sont bien réalisées. Attention à n'utiliser que les adresses e-mail des testeurs, pour éviter que vos clients ner eçoivent ces messages.

1.4.2. Plateforme Production

  • Accès aux API limité à 1.000 requêtes par jour
  • Seuils d'échec mis en place :
    • 5 demandes de renvoi de SMS, par signataire et par contrat
    • 5 échecs au maximum de signature d'un contrat par un signataire

1.5. Marque, CGU

Il est à noter que la marque «Efalia Sign» apparaît dans le SMS reçu par le signataire pour obtenir son code de signature et dans la dernière page des documents signés. Pour éviter toute surprise, nous vous recommandons d'informer vos utilisateurs que votre service utilise Efalia Sign.

Nous vous invitons également à mettre en conformité vos conditions d'utilisation en utilisant tout ou partie de nos CGU (https://www.contrat-prive.com/fr/product/terms-of-use).

Pour une utilisation en marque blanche complète au travers d'un projet sur mesure, veuillez nous contacter via : https://www.contrat-prive.com/fr/product/contact

1.6. Assistance technique

Une assistance technique est à votre disposition via le formulaire de contact ou par e-mail à l'adresse support.api@contrat-prive.com

2. API disponibles