Aller au contenu principal

Guide d'Utilisation de l'API de Création de Certificat

Ce guide détaille les étapes nécessaires à l'utilisation de l'API de Certificall pour la création et la gestion de dossiers certifiés. Suivez les instructions ci-dessous pour configurer et opérer votre système avec efficacité.

Prérequis​

Avant de commencer, assurez-vous de remplir les conditions suivantes :

Compte et Accès API​

  • Accès API : Un accès utilisateur API est requis. Contactez votre administrateur Certificall pour activer cet accès si ce n'est pas déjà fait.

Configuration de la Trame​

  • Trame d'Entreprise : Vous devez avoir une trame associée à votre entreprise. Configurez-la via votre espace admin fourni par Certificall.

Authentification​

  • Obtention du JWT Token : Le token est essentiel pour interagir avec l'API. Récupérez-le via le endpoint /certificall/api/auth/token. Pour plus de détails, consultez la documentation Swagger ici ou notre guide complet.

Procédure d'Utilisation de l'API​

1. Récupération de la Trame​

Objectif : Identifier la structure du dossier à créer en récupérant les informations de la trame.

  1. Endpoint : /certificall/api/frames
    • Consultez notre interface Swagger pour des informations complètes.
  2. Réponse Attendue : 
    class StepDto {
      id: number;
      title: string;
      description: string;
    }

    export class PublicFramesDto {
      id: number;
      name: string;
      steps: StepDto[];
    }
    • Importance : Gardez trace des id des étapes pour les utiliser dans les étapes suivantes de la création de dossier.

2. Ouverture d'un Dossier​

Objectif : Initialiser un dossier qui va structurer le recueil des informations selon la trame récupérée.

  1. Endpoint : POST /certificall/api/cases/create
    • Intégrez l'identifiant de trame pour lier le dossier à une séquence d'étapes et de contenus attendus.
  2. Paramètres Importants : 
    export class CreateCaseDto {
      frameId: number;
      options?: DeeplinkParams;
    }

Les paramètres de deeplink sont optionnels et permettent de réaliser divers actions au sein de certificall cf : https://doc.certificall.app/docs/admin/deeplink

3. Création des Items​

Objectif : Remplir les étapes du dossier avec les contenus requis, y compris les photos certifiées.

  1. Endpoint : POST /api/items
    • Chaque contenu envoyé doit être associé à un stepId et un caseId.
  2. Pour les Photos : Les détails de géolocalisation sont obligatoires.

Le dto attendu pour un item doit être de la forme suivante :

class CreateItemBaseDto {
  stepId: number;
  data: string; // pour une photo il s'agit du nom du fichier, pour un contenu autre il s'agit du contenu
  userDeviceManufacturer: string;
  userDeviceModel: string;
  userDeviceName: string;
  userDevicePlatform: string;
  userDeviceOs: string;
  userDeviceOsVersion: string;
  userDeviceCarrierIpAddress?: string;
  userDeviceWifiIpAddress?: string;
  geolocLatitude: string;
  geolocLongitude: string;
  geolocAccuracy?: string;
}

4. Clôture du Dossier​

Objectif : Finaliser le dossier pour qu'il devienne consultable et archivable.

  • Endpoint : GET /certificall/api/cases/close/{caseId}
    • Cela rend le dossier non modifiable et initie la génération du PDF récapitulatif.

5. Récupération du Dossier​

Objectif : Accéder au dossier finalisé pour consultation ou intégration dans vos systèmes.

  • Endpoint : GET /certificall/api/cases
    • Utilisez caseId pour accéder au dossier et à ses métadonnées.