Skip to main content

Public Media Access

This document details the public endpoints for accessing images and videos shared via the Certificall API.

Retrieving a Shareable Image​

Endpoint: GET /images/:imageUrl​

Description​

This public API endpoint allows retrieving a shareable image associated with a certificate. This endpoint does not require authentication and allows direct access to images via an encoded URL.

Request​

  • URL: /images/:imageUrl

  • HTTP Method: GET

  • Path parameters:

    • imageUrl: string - Encoded URL of the image to retrieve.

  • Required headers: None (public endpoint)

Response​

Successful response:

  • Status Code: 200 OK
  • Content Type: image/png
  • Content Disposition: inline (display in browser)

Response headers:

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

The response body contains the binary image file.

Error response:

  • Status Code: 400 Bad Request

  • Description: The image URL is invalid or malformed.

  • Status Code: 404 Not Found

  • Description: The image does not exist or is no longer available.

URL Format​

The image URL is generally provided in the responses of other API endpoints, including:

  • In the imageUrl field of items returned by /cases
  • In the metadata of certificates returned by /reports/:reportToken

Full URL example:

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

Use Cases​

Use this endpoint to:

  • Display certificate images in a web interface
  • Download photos associated with an inspection
  • Integrate images into custom reports
  • Create image galleries from certificates

Characteristics​

  • Public access: No authentication needed
  • Rate limiting: Abuse protection via throttling
  • Format: Images returned in PNG format
  • Display: Images are returned in inline mode for direct display

Usage Example​

HTML usage example:

<img src="https://admin.certificall.app/certificall/images/object-name"
     alt="Inspection photo" />

Retrieving a Shareable Video​

Endpoint: GET /medias/video/:videoUrl​

Description​

This public API endpoint allows retrieving a shareable video associated with a certificate. This endpoint does not require authentication and allows direct access to videos via an encoded URL.

Request​

  • URL: /medias/video/:videoUrl

  • HTTP Method: GET

  • Path parameters:

    • videoUrl: string - Encoded URL of the video to retrieve.

  • Required headers: None (public endpoint)

Response​

Successful response:

  • Status Code: 200 OK
  • Content Type: video/mp4
  • Content Disposition: inline (playback in browser)

Response headers:

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

The response body contains the binary video file in streaming.

Error response:

  • Status Code: 400 Bad Request

  • Description: The video URL is invalid or malformed.

  • Status Code: 404 Not Found

  • Description: The video does not exist or is no longer available.

URL Format​

The video URL is generally provided in the responses of other API endpoints, including:

  • In the metadata of video items returned by /cases
  • In the details of certificates returned by /reports/:reportToken

Full URL example:

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

Use Cases​

Use this endpoint to:

  • Play inspection videos in a web player
  • Download videos associated with a certificate
  • Integrate videos into custom interfaces
  • Archive video evidence from interventions

Characteristics​

  • Public access: No authentication needed
  • Rate limiting: Abuse protection via throttling
  • Format: Videos returned in MP4 format
  • Streaming: Videos are streamed for optimal playback
  • Display: Videos are returned in inline mode for direct playback

Security and Best Practices​

  • URLs contain encoded information that serves as a secure access key
  • Only share image and video URLs with authorized persons
  • URLs can be directly embedded in HTML tags (<img>, <video>)
  • These endpoints are subject to rate limiting to prevent abuse
  • Videos can be large, ensure you have a stable connection

By following these instructions, you will be able to securely access shared media via the Certificall API.