Vue d'ensemble : Image API

L'API Image vous permet de récupérer une version redimensionnée, recadrée ou pivotée d'une image.

Introduction

L'API Brightcove Image offre un moyen simple et rapide de redimensionner, recadrer et/ou faire pivoter une image à l'aide d'une simple requête GET.

URL de demande

L'URL de requête pour l'API Image est :

https://images.brightcovecdn.com/image/v1/{account_id}/{image-token}/url/{image_url}

Les paramètres de chemin requis sont :

  • account_id: votre identifiant de compte Video Cloud
  • image-token: jeton d'authentification pour votre compte (doit être généré par Brightcove Support)
  • image_url: une URL publique où l'image peut être trouvée

Paramètres d'URL

Pour obtenir une version transformée de votre image, utilisez un ou plusieurs des paramètres d'URL décrits ci-dessous dans votre demande. Notez que vous pouvez utiliser n'importe quelle combinaison des 3 paramètres.

Paramètres d'URL pour l'API d'image
Paramètre Description
resize Redimensionnez l'image en lui donnant la valeur « widthxheight » (exemple : resize=160x90)
fallback Si true, l'API renvoie une image noire si elle n'est pas en mesure de renvoyer l'image demandée.
fillArea Conserver le rapport hauteur/largeur de l'image en remplissant entièrement la zone donnée par le paramètre de redimensionnement. Le comportement par défaut consiste à ne remplir qu'un seul côté de la même zone.
crop Recadrez la largeur et la hauteur en les réglant sur « widthxheight ». Exemple : crop=160x90- le point d'origine est le centre de l'image.
rotate fait pivoter l'image dans le sens des aiguilles d'une montre selon le nombre de degrés spécifié. Exemple : rotate=90
nocache Sitrue la réponse de l'API inclura un Cache-Control en-tête avec la valeur public, max-age=0.
watermark Si true une icône de bouton de lecture doit être ajoutée à l'image

Les meilleures pratiques

Si vos images transformées seront affichées sur des pages Web ou dans des applications en ligne, utilisez l'API pour récupérer les images et les stocker sur votre serveur. Faire ne pas les récupérer au moment de l'exécution, car la limitation du débit sur l'API entraînerait l'échec de certaines demandes sur les pages ou les applications à fort trafic, et cela dégraderait également les performances de votre page/application en forçant les demandes d'API à être effectuées chaque fois qu'elle est chargée par un utilisateur.

Exemples

Voici l'image originale pour les exemples ci-dessous :

Image originale
Image originale (726x985)

Redimensionné (à l'aide du resize paramètre)

Requête

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=221x300
Image redimensionnée
Image redimensionnée

Tondu

Requête

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?crop=580x670
Image recadrée
Image recadrée

Tourné

Requête

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?rotate=-90
Image pivotée
Image pivotée

Redimensionnement et zone de remplissage

Requête

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=200x300&fillArea=true
Redimensionnement et zone de remplissage
Redimensionnement et zone de remplissage

Redimensionné et pivoté

Requête

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=221x300&rotate=-90
Image redimensionnée et pivotée
Image redimensionnée et pivotée

Recadrée et pivotée

Requête

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?crop=570x660&rotate=-90
Image recadrée et pivotée
Image recadrée et pivotée

Redimensionné, recadré et pivoté

Requête

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=221x300&crop=570x660&rotate=-90
Image redimensionnée, recadrée, pivotée
Image redimensionnée, recadrée, pivotée

En filigrane

Requête

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?watermark=true
En filigrane
En filigrane

Pas de cache

Requête

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=221x300&nocache=true

Voici les en-têtes de la réponse (renvoyée par Insomnia).

En-têtes de réponse
En-têtes de réponse