Aller au contenu principal

Accès aux Médias Publics

Ce document détaille les endpoints publics permettant d'accéder aux images et vidéos partagées via l'API Certificall.

Récupération d'une Image Partageable​

Endpoint : GET /images/:imageUrl​

Description​

Ce point d'API public permet de récupérer une image partageable associée à un certificat. Cet endpoint ne nécessite pas d'authentification et permet l'accès direct aux images via une URL encodée.

Requête​

  • URL : /images/:imageUrl

  • Méthode HTTP : GET

  • Paramètres de chemin :

    • imageUrl : string - URL encodée de l'image à récupérer.

  • Headers requis : Aucun (endpoint public)

Réponse​

Réponse en cas de succès :

  • Code Statut: 200 OK
  • Type de Contenu: image/png
  • Disposition du Contenu: inline (affichage dans le navigateur)

En-têtes de réponse :

Content-Type: image/png
Content-Disposition: inline

Le corps de la réponse contient le fichier image binaire.

Réponse en cas d'erreur :

  • Code Statut: 400 Bad Request

  • Description: L'URL de l'image est invalide ou mal formée.

  • Code Statut: 404 Not Found

  • Description: L'image n'existe pas ou n'est plus disponible.

Format de l'URL​

L'URL de l'image est généralement fournie dans les réponses des autres endpoints de l'API, notamment :

  • Dans le champ imageUrl des items retournés par /cases
  • Dans les métadonnées des certificats retournés par /reports/:reportToken

Exemple d'URL complète :

https://admin.certificall.app/certificall/images/object-name

Cas d'Utilisation​

Utilisez cet endpoint pour :

  • Afficher les images d'un certificat dans une interface web
  • Télécharger les photos associées à une inspection
  • Intégrer les images dans des rapports personnalisés
  • Créer des galeries d'images à partir des certificats

Caractéristiques​

  • Accès public : Pas besoin d'authentification
  • Rate limiting : Protection contre les abus via throttling
  • Format : Images retournées au format PNG
  • Affichage : Les images sont retournées en mode inline pour affichage direct

Exemple d'Utilisation​

Exemple d'utilisation en HTML :

<img src="https://admin.certificall.app/certificall/images/object-name"
     alt="Photo d'inspection" />

Récupération d'une Vidéo Partageable​

Endpoint : GET /medias/video/:videoUrl​

Description​

Ce point d'API public permet de récupérer une vidéo partageable associée à un certificat. Cet endpoint ne nécessite pas d'authentification et permet l'accès direct aux vidéos via une URL encodée.

Requête​

  • URL : /medias/video/:videoUrl

  • Méthode HTTP : GET

  • Paramètres de chemin :

    • videoUrl : string - URL encodée de la vidéo à récupérer.

  • Headers requis : Aucun (endpoint public)

Réponse​

Réponse en cas de succès :

  • Code Statut: 200 OK
  • Type de Contenu: video/mp4
  • Disposition du Contenu: inline (lecture dans le navigateur)

En-têtes de réponse :

Content-Type: video/mp4
Content-Disposition: inline

Le corps de la réponse contient le fichier vidéo binaire en streaming.

Réponse en cas d'erreur :

  • Code Statut: 400 Bad Request

  • Description: L'URL de la vidéo est invalide ou mal formée.

  • Code Statut: 404 Not Found

  • Description: La vidéo n'existe pas ou n'est plus disponible.

Format de l'URL​

L'URL de la vidéo est généralement fournie dans les réponses des autres endpoints de l'API, notamment :

  • Dans les métadonnées des items vidéo retournés par /cases
  • Dans les détails des certificats retournés par /reports/:reportToken

Exemple d'URL complète :

https://admin.certificall.app/certificall/medias/video/object-name

Cas d'Utilisation​

Utilisez cet endpoint pour :

  • Lire les vidéos d'inspection dans un lecteur web
  • Télécharger les vidéos associées à un certificat
  • Intégrer les vidéos dans des interfaces personnalisées
  • Archiver les preuves vidéo d'interventions

Caractéristiques​

  • Accès public : Pas besoin d'authentification
  • Rate limiting : Protection contre les abus via throttling
  • Format : Vidéos retournées au format MP4
  • Streaming : Les vidéos sont streamées pour une lecture optimale
  • Affichage : Les vidéos sont retournées en mode inline pour lecture directe

Sécurité et Bonnes Pratiques​

  • Les URLs contiennent des informations encodées qui servent de clé d'accès sécurisée
  • Ne partagez les URLs d'images et vidéos qu'avec les personnes autorisées
  • Les URLs peuvent être intégrées directement dans des balises HTML (<img>, <video>)
  • Ces endpoints sont soumis à rate limiting pour éviter les abus
  • Les vidéos peuvent être volumineuses, assurez-vous d'avoir une connexion stable

En suivant ces instructions, vous pourrez accéder en toute sécurité aux médias partagés via l'API Certificall.