Aller au contenu principal

Récupération des métadonnées d'un rapport via un jeton de rapport

Endpoint : GET /reports/:reportToken​

Description​

Ce point d'API permet aux utilisateurs de récupérer les métadonnées d'un rapport spécifique en utilisant un jeton de rapport. Le reportToken est transmis directement dans l'URL en tant que paramètre et sert de clé pour accéder à tous les certificats associés à un rapport.

Le reportToken est un moyen utilisé pour faire corréler un certificat à un identifiant provenant d'un contexte tiers (comme un système CRM ou une autre application) lorsqu'il est renseigné dans un deeplink avec le paramètre reportId.

Requête​

  • URL : /reports/:reportToken

  • Méthode HTTP : GET

  • Paramètres de chemin :

    • reportToken : string - Le jeton unique qui identifie le rapport.

  • Headers requis : Aucune authentification n'est nécessaire pour ce endpoint public.

Réponses​

  • Réponse en cas de succès :

    • Statut : 200 OK
    • Description : Retourne un tableau d'objets JSON contenant les métadonnées du rapport.
    • Type : Array<CaseForApiResponseDto>
    • Exemple de réponse : 
      [
        {
          "cfRef": "CAS-7264_CMP-1",
          "createdAt": "2023-11-09T13:24:40+01:00",
          "reportId": "12345",
          "frame": "Initial",
          "closed": false,
          "caseUrl": "https://certificall.app/reports/CAS-7264_CMP-1",
          "items": [
            {
              "itemName": "Photo1",
              "itemUrl": "https://certificall.app/reports/CAS-7264_CMP-1/photo1.jpg"
            }
          ]
        }
      ]

  • Réponse en cas d'erreur :

    • Statut : 400 Bad Request
    • Description : La requête est invalide, par exemple si le reportToken est incorrect ou manquant.
    • Exemple de réponse : 
      {
        "statusCode": 400,
        "message": "Invalid report token",
        "error": "Bad Request"
      }

Modèle de données​

  • CaseForApiResponseDto :

    • cfRef : string - Référence unique du cas.
    • createdAt : Date (ISO 8601) - Date de création du rapport.
    • reportId : string - Identifiant unique du rapport.
    • frame : string - État ou étape du rapport.
    • closed : boolean - Statut indiquant si le rapport est fermé.
    • caseUrl : string - URL vers les détails du rapport.
    • items : Array<ItemDto> - Liste des éléments associés au rapport.

  • ItemDto :

    • itemName : string - Nom de l'élément.
    • itemUrl : string - URL de l'élément.