Référence

Matériaux d’édition

GET /v1/edit-materials renvoie, page par page et dans l’ordre du catalogue, les matériaux et textures utilisables dans une édition par masque. La liste peut se filtrer par catégorie (bois, pierre, peinture…) ou par nom. Passez l’id d’un matériau dans le champ material d’un calque modify d’une édition.
curl "https://api.renderthink.com/v1/edit-materials?category=wood&lang=fr&limit=20" \
-H "Authorization: Bearer $RENDERTHINK_API_KEY"
Paramètres de l’URL :
NomTypeDescription
categorychaîneid d’une catégorie (voir « Catégories » ci-dessous) : seuls les matériaux de cette catégorie et de ses sous-catégories sont renvoyés.
searchchaîneTexte cherché dans le nom des matériaux, toutes langues confondues, sans tenir compte des accents. 100 caractères au plus.
limitentierNombre d’objets par page, de 1 à 100. Par défaut : 20.
afterchaîneid du dernier objet de la page précédente (voir Pagination).
langchaîneLangue des noms : fr ou en. Par défaut : en.
category et search peuvent se combiner. Droit de la clé : edits.
Une liste d’objets edit_material :
json
{
"object": "list",
"data": [
{
"object": "edit_material",
"id": "mat_4Zq8nV2bXk7pLr9TcW3yHd",
"name": "Chêne clair",
"image_url": "https://cdn.renderthink.com/...",
"thumbnail_url": "https://cdn.renderthink.com/...",
"category": "wood"
}
],
"has_more": true
}
ChampTypeDescription
objectchaîneToujours edit_material.
idchaîneIdentifiant du matériau (mat_…), à passer dans le champ material d’un calque.
namechaîneNom dans la langue demandée, ou dans la langue d’origine du catalogue s’il n’est pas traduit.
image_urlchaîneURL publique de l’image du matériau.
thumbnail_urlchaîne ou nullURL publique d’une vignette, à afficher dans une liste de choix ; null si le matériau n’en a pas.
categorychaîne ou nullid de sa catégorie (voir « Catégories »), ou null s’il n’en a pas.
GET /v1/edit-material-categories renvoie les grandes catégories de matériaux (bois, pierre, peinture…) qui contiennent au moins un matériau, sous-catégories comprises, dans l’ordre du catalogue et en une seule page. Leur id est stable : c’est la valeur du filtre category.
curl "https://api.renderthink.com/v1/edit-material-categories?lang=fr" \
-H "Authorization: Bearer $RENDERTHINK_API_KEY"
Paramètre de l’URL : lang, la langue des noms, fr ou en (par défaut : en). Droit de la clé : edits.
json
{
"object": "list",
"data": [
{ "object": "edit_material_category", "id": "wood", "name": "Bois" },
{ "object": "edit_material_category", "id": "stone", "name": "Pierre" }
],
"has_more": false
}
ChampTypeDescription
objectchaîneToujours edit_material_category.
idchaîneIdentifiant stable (wood, stone…).
namechaîneNom dans la langue demandée.
StatutCodeCause
400parameter_invalidlimit hors de 1 à 100, after mal formé ou inconnu, category qui n’est pas l’id d’une catégorie, search de plus de 100 caractères, ou lang autre que fr ou en.
Les erreurs communes à toutes les routes (clé, droits, limites) sont dans Erreurs.