Documentation de l'API FrameIT

Mis à jour de Corine Barbazanges

FrameIT transforme n'importe quelle image en un objet 3D pour l'afficher en Réalité augmentée sur mobile. FrameIT intègre une variété de styles et de couleurs de cadres, offrant à l'utilisateur la possibilité de s'assurer que non seulement la taille et le style d'une oeuvre, mais aussi celui de son encadrement, s'harmonisent avec son intérieur. 

SENAR FrameIt in AR

DÉMO API

Visualisez deux applications pratiques sur notre page de démonstration.

  • Boutique en ligne
  • Galerie d'Art

Vous pouvez accéder à ces démos ici.

PARAMÈTRES DE l'API FrameIT

Pour obtenir votre clé API, contactez-nous via le bouton 'Contact' situé en haut de cette page.

URL de base de l'API :  https://www.frameit.ar/api/frameit

Endpoint : /

Description : Ajoute un cadre à une image donnée.

Méthode HTTP : POST

Paramètres de la requête :

PARAMÈTRE

DESCRIPTION

VALEURS (peuvent être étendues, à la demande)

File

Fichier image à traiter

Formats supportés: JPG, PNG, BMP

File

ImageUrl

URL de l'image à traiter

Formats supportés: JPG, PNG, BMP

ImageUrl

Unit

Unité utilisé pour les dimensions

cm (centimètres), in (inches)

ImageWidth

Largeur souhaitée hors cadre, en AR

Tout nombre positif

(séparateur décimal : point)

ImageHeight

Hauteur souhaitée hors cadre, en AR

(Optionnelle)

Tout nombre positif

(séparateur décimal : point)

MatWidth

Largeur du passe-partout

(Optionnelle)

0: ignoré (sans passe-partout)

Tout nombre positif (séparateur décimal : point)

SupportType

Type de support

Canvas, Dibond, Photo, Plexiglass, Poster *

FrameType

Type de cadre

None, Thin_Wood, Large_Wood, Thin_Floater, Floater, Aluminum *

FrameColor

Couleur du cadre (Optionnelle)

Black, White, Natural_Oak, Gold, Silver, Copper *

* Types de support : Toile, Dibond (plaque aluminium), Photo, Plexiglass, Affiche

Types de cadre : Aucun, Bois fin, Bois large, Caisse américaine profils fins, Caisse américaine profils épais, Aluminium

Couleurs de cadre : Noir, Blanc, Chêne naturel, Or, Argent, Cuivre

Associations disponibles (type & couleur de cadre)

  • Thin_Wood : disponible avec Black, White, Natural_Oak
  • Large_Wood : disponible avec Gold
  • Thin_Floater : disponible avec Black, White, Natural_Oak
  • Floater : disponible avec Black, White, Natural_Oak
  • Aluminum : disponible avec Black, White, Gold, Silver, Copper
    NB : soyez vigilant sur l'orthographe du mot "Aluminum" (un seul "i" en anglais).

EXEMPLE DE REQUÊTE

REQUÊTE

RÉPONSE

POST https://www.frameit.ar/api/frameit

Content-Type: multipart/form-data

Authorization: Basic api:votre-clé-API

File: [fichier image]

Unit: cm

SupportType: Photo

ImageWidth: 60.7

MatWidth: 5

FrameType: Thin_Wood

FrameColor: Natural_Oak

{

    "PublicLink": "https://public-link",

    "QrCodeImage": "https://qrcode-image"

}

Exemple de code en Javascript

// Function to make the API request
async function uploadImage() {
// API endpoint
const url = 'https://www.frameit.ar/api/frameit';

// Prepare the form data
const formData = new FormData();

// Replace this with the URL of the image you want to use
const imageUrl = 'https://example.com/path/to/image.jpg';
formData.append('ImageUrl', imageUrl);

// Append other parameters to the form data
formData.append('Unit', 'cm');
formData.append('SupportType', 'Photo');
formData.append('ImageWidth', '60.7');
formData.append('MatWidth', '5');
formData.append('FrameType', 'Thin_Wood');
formData.append('FrameColor', 'Natural_Oak');

// Set up the request headers
const headers = new Headers(); 
headers.append('Authorization', 'Basic ' + btoa('api:your-API-key'));

// Make the request
try {
const response = await fetch(url, {
method: 'POST',
headers: headers,
body: formData
});

if (!response.ok) {
throw new Error(HTTP error! status: ${response.status});
}

// Get the response JSON
const data = await response.json();
console.log(data);
} catch (error) {
console.error('Error:', error);
}
}

// Call the function (e.g., on a button click)
uploadImage();

Exemple de code en Python

import requests
from requests.auth import HTTPBasicAuth
import base64

# API endpoint
url = 'https://www.frameit.ar/api/frameit'

# Your API key
api_key = 'Your-API-Key'

def get_frameit_response():
# Image file path
file_path = 'images/sample1.jpg'
files = {'file': open(file_path, 'rb')}

# Data payload
data = {
'Unit': 'cm',
'SupportType': 'Photo',
'ImageWidth': 60.7,
'MatWidth': 5,
'FrameType': 'Thin_Wood',
'FrameColor': 'Natural_Oak'
}

# Basic authentication
auth = HTTPBasicAuth('api', api_key)

# Make the POST request
response = requests.post(url, files=files, data=data, auth=auth)

# Print the response
print(response.json())
return response.json()

get_frameit_response()

Codes de réponse HTTP

  • 200 OK : la requête a réussi et la réponse contient les données demandées.
  • 400 Bad Request : la requête est mal formulée ou contient des paramètres incorrects.
  • 500 Internal Server Error : une erreur s'est produite côté serveur.


Cet article vous a-t-il été utile ?


Powered by HelpDocs (opens in a new tab)