Récupération des pièces jointes

Pièces jointes

Récupération des photos

Lors de votre appel API pour récupérer le détail de la demande, GET /operations, si des photos sont jointes, vous pourrez directement les récupérer depuis le JSON retourné.

Dans le JSON, vous trouverez les photos dans la rubrique "logs". Dans la rubrique "logs/photos", nous vous indiquons l'url des requêtes API GET pour récupérer ces photos.
"logs": [
   {
      "photos": [
         {
              "original": "https://api.hubintent.com/api/photos/v1/photos/5fb7e5ca1e256b43aa786e9407aef6f805faa825%2F0736f3fc-de49-40c7-a808-72a7e2faf97c?type=operation",
              "thumbnail": "https://api.hubintent.com/api/photos/v1/photos/5fb7e5ca1e256b43aa786e9407aef6f805faa825%2F0736f3fc-de49-40c7-a808-72a7e2faf97c?type=operation&version=thumbnail"
         },
         {
              "original": "https://api.hubintent.com/api/photos/v1/photos/5fb7e5ca1e256b43aa786e9407aef6f805faa825%2Fd6206b15-a123-4d06-868b-d141b35a715a?type=operation",
              "thumbnail": "https://api.hubintent.com/api/photos/v1/photos/5fb7e5ca1e256b43aa786e9407aef6f805faa825%2Fd6206b15-a123-4d06-868b-d141b35a715a?type=operation&version=thumbnail"
          }
      ]
   }
]

Récupération des documents

Webhook

Vous pouvez recevoir un webhook dès qu'un nouveau document vous est partagé.
[
  {
    "type": "documents:asset:insert",
    "event": {
        "type": "document",
        "body": {
            "id": "a061-ee-0d-21-8b3409",
            "reference": "01-L07",
            "contractReference": "contract1",
            "fileKey": "68500e9716527e70f0b00f96a00391030d1199d5/aefad061-eed8-4d0d-8821-8b32b5984409",
            "fileName": "ELEC-007890-0650.pdf",
            "url": "https://hubintent.com/v2/#/data/documents/detail/615a792d46c6",
            "urlApi": "https://api.hubintent.com/api/documents/v1/documents/a061-ee-0d-21-8b3409",
            "title": "ELEC-007890-0650",
            "description": "",
            "type": "asset"
        }
     }
  }
]

Le type dans le body vous indique si le document est rattaché à:
  • une intervention "type":"intervention"
  • un élément de patrimoine asset "type":"asset"

Vous pouvez récupérer le détail des informations du document en réalisant un appel API sur le champ urlApi : GET /documents/{id}

Vous pouvez télécharger le document en réalisant un appel API sur le champ urlApi : GET /documents/{id} et en rajoutant /download à la fin de la requête.

Polling

API documents v1
Méthode : GET
Paramètres : since={date}
/api/documents/v1/documents?since=2023-10-08T10:00:00

Le paramètre since vous permet de récupérer tous les nouveaux documents et les documents ayant eu des mises à jour depuis la date indiquée dans le paramètre since.
L'API Documents v1 est paginée, c'est à dire que vous ne pouvez pas récupérer plus de 100 documents par page, il faudra donc utiliser la pagination comme indiqué ici  Gestion de la pagination des API  s 

Dans le JSON, vous trouverez l'ensemble des informations du document.
Vous pourrez directement télécharger le document en réalisant un GET sur l'url indiquer dans la rubrique "_links/download".

Liens HAL intervention

Il peut arriver que les documents soient publiés quelques secondes ou heures après la création de la demande d'intervention. Dans ce cas là, la solution des liens HAL n'est pas recommandée car vous risquez de ne pas récupérer les documents lors de la récupération de la demande d'intervention.
Lors de votre appel API pour récupérer le détail de la demande, GET /operations, si des documents sont joints, vous pourrez directement les récupérer depuis le JSON retourné au travers des liens HAL.

Dans le JSON, vous trouverez l'url à appeler dans la rubrique "_links/documents:list". En faisant un GET sur cette url, vous pourrez accéder à tous les documents du ticket.
"_links": {
        "self": {
            "href": "https://apisandbox.hubintent.com/api/operations/v2/operations/contract1_201007151812?contractReference=contract1"
        },
        "documents:list": {
            "href": "https://apisandbox.hubintent.com/api/documents/v1/documents?elementType=intervention&elementReference=contract1_201007151812"
        },
        "actions:reservation:create": {
            "href": "https://apisandbox.hubintent.com/api/operations/v2/reservations/logs"
        }
    },

Il est également possible que les documents soient directement intégrés à l'intervention. Dans le log de l'intervention, vous retrouverez le lien de consultation du/des document(s) ou de téléchargement du/des document(s).
"documentUrls": [
                "https://api.hubintent.com/api/documents/v1/documents/af52d65f-27fb-4895-bf9b-7de1b3097276/download",
                "https://api.hubintent.com/api/documents/v1/documents/ca995227-be2a-42b3-8bfb-91f7d7a5c137/download"
            ],