Aller au contenu principal

Documentation API - Endpoint de Recherche de Certificats

Ce document détaille le fonctionnement et l'utilisation du endpoint public pour rechercher des certificats en fonction de critères spécifiques au sein de l'application Certificall.

Introduction​

Le endpoint de recherche de certificats permet aux utilisateurs authentifiés d'interroger et de récupérer des certificats enregistrés dans le système Certificall, en appliquant des filtres variés pour affiner les résultats selon les besoins spécifiques.

Authentification​

L'accès à ce endpoint nécessite une authentification valide. Incluez un token JWT (JSON Web Token) dans l'en-tête de votre requête HTTP comme suit :

Authorization: Bearer <Votre_Token_JWT>

Requête HTTP​

GET /cases

Paramètres de la requête (Query Parameters)​

  • reportToken (String, optionnel): Token du rapport associé aux certificats recherchés.
  • companyId (Number, optionnel): Identifiant de l'entreprise associée aux certificats.
  • nieCode (String, optionnel): Code NIE spécifique aux certificats.
  • frameId (Number, optionnel): Identifiant de la trame utilisée pour les certificats.
  • hours (Number, optionnel): Nombre d'heures dans le passé pendant lesquelles les certificats ont été créés maximum 240 heures, par défaut 12 heures.
  • withReportToken (Boolean, optionnel): Indique si le token du rapport doit être inclus dans les résultats.
  • closed (Boolean, optionnel): Filtre les certificats selon leur statut (ouvert/fermé).
  • format (Enum, requis): Spécifie le format de la réponse (ZIP ou URL), utilisant RESPONSE_FORMAT.
  • caseId (Number, optionnel): Identifiant du certificat recherché.

Attention : précisez hours si vous souhaitez recevoir les certificats antérieurs aux 12 dernières heures

Exemple :

curl -X 'GET' \ 'https://admin.certificall.app/certificall/api/cases?format=metadata&hours=48' \ -H 'accept: application/json' \ -H 'Authorization: Bearer xxxx

Réponse​

200 OK : Retourne une liste de certificats correspondant aux critères spécifiés.

Exemple de réponse pour une demande avec format=URL :

[
  {
    "cfRef": "REF123",
    "closingDate": "2023-01-01T00:00:00Z",
    "createdAt": "2022-12-01T00:00:00Z",
    "closed": true,
    "frameName": "Trame A",
    "companyName": "Entreprise XYZ",
    "nieCode": "NIE123",
    "reportToken": "TOKEN123",
    "url": "https://certificall.example.com/download/SHARETOKEN123"
  }
]

400 Bad Request : La requête est invalide, généralement en raison de paramètres manquants ou incorrects.

500 Internal Server Error : Erreur interne du serveur empêchant le traitement de la requête.

Sécurité et Conformité​

Les interactions avec l'API Certificall doivent toujours être effectuées via une connexion sécurisée (HTTPS) pour garantir la confidentialité et l'intégrité des données transmises. Les tokens d'authentification JWT doivent être gérés de manière sécurisée pour prévenir tout accès non autorisé.