Synupv1
Créer une clé
v1Ressources/Media/postTéléchargez un fichier multimédia

Téléchargez un fichier multimédia

Ajoute une nouvelle photo ou vidéo à la médiathèque de l'agence à partir d'une URL ou d'une charge utile encodée en base64, éventuellement limitée à un compte, un client, un établissement ou une marque.

post/api/v1/media/upload
media:write
Corps de la requête
urlstringfacultatif
Une URL publiquement accessible à partir de laquelle récupérer le fichier. Fournissez ceci ou base64, pas les deux.
base64stringfacultatif
Le contenu brut du fichier, encodé en base64. Fournissez ceci ou url, pas les deux.
mimestringfacultatif
Type MIME du fichier, par ex. image/jpeg. Déduit si omis.
filenamestringfacultatif
Nom de fichier d'origine, utilisé pour l'affichage.
titlestringfacultatif
Un titre lisible pour le fichier.
scopeTypestring (account | client | location | brand)facultatif
À quoi appartient ce fichier : account (toute l'agence), client, location ou brand.
scopeIdstringfacultatif
L'id du client ou de l'établissement auquel le fichier est limité, lorsque scopeType est client ou location.
folderIdstringfacultatif
Un dossier de fichiers existant dans lequel classer ce téléchargement.
tagsarray of stringfacultatif
Étiquettes libres à associer au fichier.
locationIdsarray of stringfacultatif
Établissements supplémentaires à associer à ce fichier, en plus de scopeId.
Réponse
dataobjectfacultatif
assetobjectfacultatif
keystringfacultatif
Identifiant composite du fichier, au format « <source>:<id> ».
sourcestringfacultatif
Origine de ce fichier (par ex. un envoi OS par rapport à une source importée).
idstringfacultatif
L'id du fichier au sein de sa source.
titlestringfacultatif
Le titre du fichier.
filenamestringfacultatif
Le nom de fichier d'origine du fichier.
mimestringfacultatif
Le type MIME du fichier.
kindstringfacultatif
Le type du fichier (photo ou vidéo).
sizeBytesnumberfacultatif
Taille du fichier en octets, ou null si inconnue.
urlstringfacultatif
URL prête à l'emploi pour les octets du fichier.
thumbnailUrlstringfacultatif
URL d'un aperçu miniature, ou null.
tagsarray of stringfacultatif
Étiquettes associées au fichier.
folderIdsarray of stringfacultatif
Dossiers de fichiers auxquels ce fichier appartient.
locationIdsarray of stringfacultatif
Tous les établissements auxquels ce fichier est associé.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/media/upload
Votre clé API
Corps de la requête
{
  "data": {
    "asset": {
      "key": "upload:ghi789",
      "source": "upload",
      "id": "ghi789",
      "title": "New storefront photo",
      "filename": "new-storefront.jpg",
      "mime": "image/jpeg",
      "kind": "image",
      "sizeBytes": 398211,
      "url": "https://cdn.synup.com/media/ghi789.jpg",
      "thumbnailUrl": "https://cdn.synup.com/media/ghi789-thumb.jpg",
      "tags": [],
      "folderIds": [],
      "locationIds": []
    }
  }
}