Téléverser un asset

curl --request POST \
  --url https://macaly.com/api/client-app/assets/upload \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://macaly.com/api/client-app/assets/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://macaly.com/api/client-app/assets/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://macaly.com/api/client-app/assets/upload"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://macaly.com/api/client-app/assets/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

POST

api

client-app

assets

upload

Téléverser un asset

curl --request POST \
  --url https://macaly.com/api/client-app/assets/upload \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://macaly.com/api/client-app/assets/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://macaly.com/api/client-app/assets/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://macaly.com/api/client-app/assets/upload"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://macaly.com/api/client-app/assets/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Téléverse un fichier dans les assets d’un chat et renvoie une URL CDN permanente. Utilisez cet endpoint pour des images, documents, fichiers audio, vidéo ou tout autre fichier que vous voulez référencer par URL dans votre application ou votre workflow.

Requête

POST /api/client-app/assets/upload

En-têtes

En-tête	Requis	Description
`Authorization`	Oui	`Bearer macaly_...`
`Content-Type`	Oui	`multipart/form-data`

Paramètres du formulaire

Champ	Type	Requis	Défaut	Description
`chatId`	string	Oui	-	Le chat dans lequel téléverser l’asset
`file`	file	Oui	-	Le fichier à téléverser. Taille maximale 20 Mo
`folderPath`	string	Non	-	Chemin de dossier séparé par des barres obliques, ex. `images/products`
`createFolders`	string	Non	`false`	`"true"`, `"1"` ou `"yes"` crée les dossiers manquants dans `folderPath`
`folderId`	string	Non	-	ID d’un dossier existant. N’envoyez pas `folderId` et `folderPath` en même temps
`title`	string	Non	Nom du fichier d’origine	Titre affiché pour l’asset
`metadata`	string (JSON)	Non	-	Objet JSON stocké avec l’asset

Indiquez soit folderId, soit folderPath, jamais les deux. L’envoi des deux renvoie une erreur 400.

Exemple de requête

curl -X POST https://www.macaly.com/api/client-app/assets/upload \
  -H "Authorization: Bearer macaly_abc123..." \
  -F "chatId=abc123def456" \
  -F "file=@./logo.png;type=image/png"

const form = new FormData();
form.append('chatId', 'abc123def456');
form.append('file', fileBlob, 'logo.png');

const response = await fetch('https://www.macaly.com/api/client-app/assets/upload', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer macaly_abc123...',
  },
  body: form,
});

const data = await response.json();
console.log(data.asset.url);

import requests

response = requests.post(
    'https://www.macaly.com/api/client-app/assets/upload',
    headers={'Authorization': 'Bearer macaly_abc123...'},
    data={'chatId': 'abc123def456'},
    files={'file': ('logo.png', open('logo.png', 'rb'), 'image/png')},
)

data = response.json()
print(data['asset']['url'])

Téléverser dans un dossier

Utilisez folderPath pour une structure de dossiers lisible, et createFolders=true pour créer les dossiers manquants sur le chemin indiqué :

cURL

curl -X POST https://www.macaly.com/api/client-app/assets/upload \
  -H "Authorization: Bearer macaly_abc123..." \
  -F "chatId=abc123def456" \
  -F "folderPath=images/products" \
  -F "createFolders=true" \
  -F "title=Product hero image" \
  -F "file=@./hero.png;type=image/png"

Réponse

{
  "success": true,
  "asset": {
    "assetId": "asset_123",
    "url": "https://cdn.macaly.app/user/chat/key/logo.png",
    "storageKey": "user/chat/key/logo.png",
    "contentType": "image/png",
    "fileSize": 12345,
    "type": "image",
    "folderId": "folder_123"
  }
}

Champ	Type	Description
`asset.assetId`	string	Identifiant unique de l’asset
`asset.url`	string	URL CDN permanente du fichier téléversé
`asset.storageKey`	string	Chemin de stockage interne
`asset.contentType`	string	Type MIME du fichier téléversé
`asset.fileSize`	number	Taille du fichier en octets
`asset.type`	string	Type d’asset déduit, ex. `image`, `document`
`asset.folderId`	string \| null	Dossier dans lequel l’asset a été placé, le cas échéant

Codes de statut

Statut	Description
200	Succès - Asset téléversé
400	`chatId` ou `file` manquant, JSON `metadata` invalide, ou `folderId` et `folderPath` envoyés ensemble
401	Clé API invalide ou manquante
403	La clé API n’a pas accès à ce chat
404	Dossier introuvable
413	Le fichier dépasse la limite de 20 Mo
500	Erreur serveur

Règles des dossiers

Les chemins de dossiers sont découpés sur /, les espaces sont supprimés et les segments vides ignorés.
La profondeur maximale est de 8 dossiers.
Chaque nom de dossier peut compter jusqu’à 255 caractères.
La correspondance des dossiers ne tient pas compte de la casse au sein d’un même parent.
Si folderPath n’existe pas et que createFolders n’est pas true, le téléversement échoue avec une erreur 404.

Bon à savoir

Cet endpoint utilise la même clé API macaly_... que le reste de l’API, même si l’URL commence par /api/client-app/. Aucun token séparé n’est nécessaire.
Le chat référencé par chatId doit appartenir à la même équipe que votre clé API.
Les assets téléversés obtiennent une URL CDN permanente que vous pouvez référencer comme pièce jointe dans Créer un chat ou Publier un message, ou utiliser n’importe où en dehors de Macaly.

Premiers pas

Endpoints

Téléverser un asset

Requête

En-têtes

Paramètres du formulaire

Exemple de requête

Téléverser dans un dossier

Réponse

Codes de statut

Règles des dossiers

Bon à savoir

​Requête

​En-têtes

​Paramètres du formulaire

​Exemple de requête

​Téléverser dans un dossier

​Réponse

​Codes de statut

​Règles des dossiers

​Bon à savoir

Requête

En-têtes

Paramètres du formulaire

Exemple de requête

Téléverser dans un dossier

Réponse

Codes de statut

Règles des dossiers

Bon à savoir