Présentation

Art AR permet aux clients de prévisualiser l'art en direct dans leur propre espace en utilisant la réalité augmentée sur Android et iOS. Les marchands peuvent personnaliser l'apparence de leur art dans la prévisualisation RA (réalité augmentée) en associant facilement leurs peintures, affiches, décalcomanies et photos avec différents cadres en 3D.

L'API Art AR est un moyen facile et entièrement personnalisable d'intégrer directement une visualisation en réalité augmentée de vos œuvres d'art dans vos pages web. L'accès à l'API Art AR nécessite une clé (API key) qu'il faudra créer au préalable depuis votre espace client. L'équipe Art AR reste joignable à l'adresse contact@artar.tech.

Utilisation

Une fois en possession de votre clé (API key), l'intégration dans vos page web se fera via un élément <iframe>, pointant sur l'URL /artConfigAPI. L'URL devra être complétée par une chaîne de requête où seront spécifiées les informations sur l'œuvre d'art à présenter.

L'API Art AR fait une distinction entre les œuvres d'art mono-variantes et les œuvres d'art multi-variantes:

les œuvres d'art mono-variantes sont les œuvres constituées d'un seul élément à visualiser, comme par exemple une peinture avec un seul type de cadre. C'est le cas le plus courant.
les œuvres d'art multi-variantes sont les œuvres constituées de plusieurs éléments à visualiser séparément, comme pour le cas d'une œuvre mais avec des présentations variées (cadre américain, cadre minimaliste, ...)

Exemples de chaîne de requête

IMPORTANT : il faudra se munir de votre clé d'accès (API key) que vous trouverez sur le tableau de bord (onglet API).

Après avoir saisi votre clé API, quelques exemples de chaînes de requêtes contenant les paramètres nécessaires pour l'utilisation de l'API Art AR seront donnés ci-après.

Chaîne de requête (mono-variante)

Le tableau suivant liste tous les paramètres attendus par l'API dans le cas d'une œuvre mono-variante:

Paramètre Type Description

passkey Texte (obligatoire) La clé (API key) récupérée depuis votre espace client.

image URL (obligatoire) L'URL de l'image à utiliser pour créer la visualisation de l'œuvre. Formats recommandés : JPEG, PNG, WebP. L'image doit être accessible publiquement via http ou https.

width Nombre entier (obligatoire) La largeur de l'œuvre, selon l'unité spécifiée par le paramètre unit. Doit être compris entre 1 et 9999 (inclus).

height Nombre entier (obligatoire) La hauteur de l'œuvre, selon l'unité spécifiée par le paramètre unit. Doit être compris entre 1 et 9999 (inclus).

depth Nombre entier (obligatoire) La profondeur de l'œuvre, selon l'unité spécifiée par le paramètre unit. Doit être compris entre 1 et 9999 (inclus).

unit

Texte

(obligatoire) L'unité de mesure des dimensions qui s'applique aux paramètres width, height et depth). Les valeurs acceptées sont:

cm pour le centimètre
inch pour le pouce

name Texte (optionnel) Le nom de l'œuvre affiché sur l'encadré descriptif de l'œuvre.

link URL (optionnel) Un lien vers une page relative à l'œuvre qui sera proposé sur l'encadré descriptif de l'œuvre.

description Texte (optionnel) Une description de l'œuvre affichée sur l'encadré descriptif de l'œuvre.

preview Booléen (optionnel) Affiche ou masque la visionneuse 3D. Les valeurs acceptées sont true et false, la valeur par défaut étant true. Avec preview=false, la visionneuse 3D est masquée et seul le bouton « Try In Your Space » est affiché.

frame

Texte

(optionnel) Le type de cadre où sera placée l'œuvre. La valeur par défaut si le paramètre n'est pas spécifié est frame1. Les valeurs permises sont listées ci-dessous. En cas de besoin particulier, l'équipe Art AR reste joignable pour s'adapter à vos besoins.

	canvas1 Canvas		canvas2 Stretched canvas
	frame_black_american American frame		frame_gold_american Gold american frame
	frameMinimalist Minimalist frame		frame1 Frame with plexiglass
	frame2 Basic frame		frame3 Antique golden frame
	frame4 Decorated golden with lambert canvas		frame5 Deep angled wooden frame
	frame6 Wooden frame with convex edge and white lip		frame7 Golden frame with ornate detail
	frame8 Silver frame with ornate detail		frame9 Modern frame: black mat board
	frame10 Contemporary black satin frame with plexiglass		frame11 Modern frame: white mat board
	frame12 Golden frame with ornaments		frame13 White picture frame
	frame14 Acrylic floating frame

Chaîne de requête (multi-variantes)

Le tableau suivant liste tous les paramètres attendus par l'API dans le cas d'une œuvre multi-variantes:

Paramètre	Type	Description
`passkey`	Texte	(obligatoire) La clé (API key) récupérée depuis votre espace client.
`variants`	Nombre entier	(obligatoire) Le nombre de variantes constituant l'œuvre. NOTE: ce paramètre influera sur les paramètres indexés (indiqués ci-après avec le suffixe `N`). Les variantes sont numérotées de 1 jusqu'à `variants`, et l'API receuillera les valeurs des paramètres indéxés (ci-après) en utilisant un suffixe numérique allant de 1 à `variants` (inclus). EXEMPLE: pour une œuvre contenant 3 variants, l'API accèdera aux paramètres suivants: `image1`, `image2`, `image3` pour les URLs d'image de chaque variante `width1`, `width2`, `width3` pour la largeur de chaque variante `unit1`, `unit2`, `unit3` pour l'unité de mesure des dimensions de chaque variante ... et ainsi de suite pour le reste des paramètres indexés.
`imageN`	URL	(obligatoire, indexé avec `N` allant de 1 jusqu'à `variants`) L'URL de l'image à utiliser pour créer la visualisation de l'œuvre. Formats recommandés : JPEG, PNG, WebP. L'image doit être accessible publiquement via http ou https.
`widthN`	Nombre entier	(obligatoire, indexé avec `N` allant de 1 jusqu'à `variants`) La largeur de l'œuvre, selon l'unité spécifiée par le paramètre `unitN`. Doit être compris entre 1 et 9999 (inclus).
`heightN`	Nombre entier	(obligatoire, indexé avec `N` allant de 1 jusqu'à `variants`) La hauteur de l'œuvre, selon l'unité spécifiée par le paramètre `unitN`. Doit être compris entre 1 et 9999 (inclus).
`depthN`	Nombre entier	(obligatoire, indexé avec `N` allant de 1 jusqu'à `variants`) La profondeur de l'œuvre, selon l'unité spécifiée par le paramètre `unitN`. Doit être compris entre 1 et 9999 (inclus).
`unitN`	Texte	(obligatoire, indexé avec `N` allant de 1 jusqu'à `variants`) L'unité de mesure des dimensions qui s'applique aux paramètres `widthN`, `heightN` et `depthN`). Les valeurs acceptées sont: cm pour le centimètre inch pour le pouce
`frameN`	Texte	(optionnel, indexé avec `N` allant de 1 jusqu'à `variants`) Le type de cadre où sera placée l'œuvre. La valeur par défaut si le paramètre n'est pas spécifié est frame1. Les valeurs permises sont les mêmes que pour le cas d'une œuvre mono-variante. En cas de besoin particulier, l'équipe Art AR reste joignable pour s'adapter à vos besoins.
`nameN`	Texte	(optionnel, indexé avec `N` allant de 1 jusqu'à `variants`) Le nom de la variante de l'œuvre affiché sur le bouton de sélection dans la vue multi-variantes.
`name`	Texte	(optionnel) Le nom de l'œuvre affiché sur l'encadré descriptif de l'œuvre.
`link`	URL	(optionnel) Un lien vers une page relative à l'œuvre qui sera proposé sur l'encadré descriptif de l'œuvre.
`description`	Texte	(optionnel) Une description de l'œuvre affichée sur l'encadré descriptif de l'œuvre.
`preview`	Booléen	(optionnel) Affiche ou masque la visionneuse 3D. Les valeurs acceptées sont true et false, la valeur par défaut étant true. Avec `preview=false`, la visionneuse 3D est masquée et seul le bouton « Try In Your Space » est affiché.

Nouveautés

Version 2.1.0 — 14 novembre 2026

Les modèles 3D sont désormais générés côté serveur : premier chargement plus rapide, et plus aucune configuration CORS n'est requise sur vos images. Les images doivent simplement être accessibles publiquement via http ou https.
Le cadre frame_gold_american fonctionne de nouveau.
Votre clé API peut être restreinte à une liste de sites web autorisés depuis votre tableau de bord (onglet API).
Le paramètre optionnel preview est maintenant documenté.