API Bephoto

Consultez la documentation ci-dessous pour automatiser vos commandes d'impression.

Documentation API Bephoto

Introduction

L'envoi des commandes d'impression se fait via une API REST. Avant de pouvoir effectuer des requêtes vers l'API, vous devez d'abord vous authentifier en utilisant les informations reçues pour obtenir un jeton d'authentification. Ce jeton doit être inclus dans l'en-tête "Authorization" de chaque requête API suivante :

Authorization: Bearer <your-authentication-token>

URL API en direct https://api.bephoto.be

Authentification

Authentifiez-vous en appelant le point de terminaison /user/login avec vos informations d'identification :

POST /user/login { "email": "<string>", "password": "<string>" }

Réponse:

{ "status": 1, "token": "<string>" }

Réponse d'erreur:

{ "error": "Unauthorized" }

Paramètres envoyés à l'API

  • email: L'adresse email de l'utilisateur.
  • password: Le mot de passe de l'utilisateur.

Création de commande

Créez une nouvelle commande en appelant /orders avec des métadonnées optionnelles. Après avoir créé une commande, vous recevrez un idorder unique, qui doit être utilisé dans les appels suivants :

POST /orders { "metadata": "<string>" }

Réponse:

{ "status": 1, "order": [{ "idorder": "<integer>", "datestart": "<timestamp>", "totalorder": "<float>", "totalcost": "<float>", "dateconfirmation": "<timestamp>", "dateprocessed": "<timestamp>", "shippingmethod": "<string>", "metadata": "<string>" }] }

Paramètres envoyés à l'API

  • metadata: Métadonnées personnalisées associées à la commande. Max. longueur : 255 caractères.

Récupérer une commande

Récupérez les informations d'une commande en appelant /orders/{IDORDER} :

GET /orders/{IDORDER}

Réponse:

{ "status": 1, "order": [{ "idorder": "<integer>", "datestart": "<timestamp>", "totalorder": "<float>", "totalcost": "<float>", "dateconfirmation": "<timestamp>", "dateprocessed": "<timestamp>", "shippingmethod": "<string>", "metadata": "<string>" }] }

Paramètres envoyés à l'API

  • idorder: L'ID unique de la commande.

Récupérer les produits

Obtenez une liste des produits d'impression disponibles en appelant /products :

GET /products

Réponse:

{ "status": 1, "products": [{ "idproduct": "<integer>", "product": "<string>", "dimensions": "<string>", "prices": [{ "price": "<float>", "idpaper": "<integer>" }] }] }

Paramètres envoyés à l'API

  • idproduct: L'ID unique du produit.
  • dimensions: Les dimensions du produit (en millimètres).
  • prices: Les prix associés au produit, avec l'ID du type de papier.

Ajouter des produits

Ajoutez des produits à votre commande en envoyant une requête POST à /orders/{IDORDER}/products :

POST /orders/{IDORDER}/products { "idproduct": "<integer>", "idpaper": "<integer>", "quantity": "<integer>", "fileurl": "<string>", "filename": "<string>", "filesize": "<integer>" }

Réponse:

{ "status": 1 }

Paramètres envoyés à l'API

  • idproduct: L'ID unique du produit à ajouter.
  • idpaper: ID du type de papier (1 pour brillant, 2 pour lustre).
  • quantity: Quantité de produit à ajouter.
  • fileurl: URL publique du fichier image à imprimer. Le fichier doit être au format JPEG et rester disponible pendant le traitement de la commande.
  • filename: Nom du fichier image à imprimer.
  • filesize: Taille du fichier en octets.

Confirmer la commande

Une fois tous les produits ajoutés, fermez la commande en appelant /orders/{IDORDER}/close :

POST /orders/{IDORDER}/close {}

Réponse:

{ "status": 1 }

Paramètres envoyés à l'API

  • idorder: L'ID unique de la commande.