Frameshop-API-Aufrufe
do=getaccesscode
Erzeuge einen API-Accesscode - ohne API-Accesscode in den API-Aufrufen werden diese nicht verarbeitet

do=getframes
CSV-Daten mit Bilderrahmen für ein Foto erhalten

do=gettotal
Überprüft den Auftragswert (und Bestand) vor der Bestellung

do=setorder
Bestellung durchgeben

do=getorderstatus
Den aktuellen Auftragsstatus abrufen


API-ID
« hier sollte deine API-ID stehen



Nützliches
Hinweise zur Integration
Demo-Integration

Frameshop-API

Mit der Frameshop-API kannst du Bilderrahmen und Leistungen aus dem Luxad direkt in deinem Shop verkaufen. Luxad ist in diesem Fall dein professioneller Dienstleister und die Frameshop-API die direkte Schnittstelle in Technologien und Leistungen.



Der Frameshop ist für Bildagenturen, Fotostudios, Fotogeschäfte und Künstler gedacht, die selber Fotos/Fotokunst verkaufen und diese mit Bilderrahmen aus dem Luxad kombinieren möchten. Die API greift dabei auf den aktuellen Bestand an Bilderrahmen aus dem Luxad zurück und ermöglicht eine Bestellung direkt über die Frameshop-API.

Voraussetzung für die Nutzung:
Eine Nachricht an info@luxad.de mit Informationen zum Projekt. Ich richte dann eine API-ID ein und helfe bei der Integration.
Wichtig: Ohne gültige API-ID oder gültigen API-Accesscode beantwortet die API keine Anfragen!

API-Accesscode erzeugen (do=getaccesscode)

Der API-Accesscode ist Grundlage für die Frameshop-API. Ohne API-Accesscode in den API-Aufrufen werden diese nicht beantwortet!
www.luxad.de/api/1.0/frameshop/
- aid Deine API-Id (erforderlich)
- do =getaccesscode (erforderlich)

Klartext:
http://www.luxad.de/api/{API-Version}/frameshop/?aid={API-ID}&do=getaccesscode

Beispiel:
http://www.luxad.de/api/1.0/frameshop/?aid=demo&do=getaccesscode

Bilderrahmen abrufen (do=getframes)

Bilderrahmendaten für ein vorhandenes Foto abrufen. Die API ermittelt für eine übergebene Bild-URL ein geeignetes Rahmenformat und liefert entsprechende Daten zurück, die von deinem Shop verarbeitet werden können.
www.luxad.de/api/1.0/frameshop/
- aid Deine API-Id (erforderlich)
- aac API-Accesscode (erforderlich)
- do =getframes (erforderlich)
- iu Die Vorschaubild-URL (URL-Kodiert) (erforderlich)
- ml Maximale Kantenlänge in cm

Klartext:
https://www.luxad.de/api/{API-Version}/frameshop/?aid={API-ID}&aac={API-Accesscode}&do=getframes&iu={URL der Bilddatei}&ml={Maximale Kantenlänge Fotodruck}

Beispiel:
https://www.luxad.de/api/1.0/frameshop/?aid=demo&aac=[API-Accesscode]&do=getframes&iu=http%3A%2F%2Fwww.luxad.de%2Fimg%2Fbilderrahmen-kapstadt.jpg

Ausgabe:
Die API liefert auf Anfragen CSV-Daten. Diese Daten können schnell und einfach verarbeitet werden.

Bestellwert prüfen (do=gettotal)

Ermittelt die Preise für den Bilderrahmen, den Fotodruck und Versand.
www.luxad.de/api/1.0/frameshop/
- aid Deine API-Id (erforderlich)
- aac API-Accesscode (erforderlich)
- do =gettotal (erforderlich)
- fsid Die eindeutige Rahmen-ID "fsid" (erforderlich)
- shr Versandtarif (z.B. DHL2Deutschland oder PICKUP) (erforderlich)
- pp=y Wenn Fotodruck gewünscht

Klartext:
https://www.luxad.de/api/{API-Version}/frameshop/?aid={API-ID}&aac={API-Accesscode}&do=gettotal&fsid={Eindeutige Bilderrahmen-Nummer}&shr={Versandtarif}&pp={Fotodruck y/n}

Beispiel:
https://www.luxad.de/api/1.0/frameshop/?aid=demo&aac=[API-Accesscode]&do=gettotal&fsid=1234&shr=DHL2Deutschland&pp=y

Ausgabe:
Die API antwortet mit einer Preisauskunft:
Rahmenpreis;Fotodruckpreis;Versandkosten;Rechnungsbetrag

Bestellung durchgeben (do=setorder)

Eine Rahmenbestellung, die auf deiner Webseite durchgeführt wird, kann und sollte direkt über die API übermittelt werden, damit der Bilderrahmen reserviert wird und die Bestellung automatisch verarbeitet werden kann.
Es kann auch nur der Rahmen (ohne Fotodruck) bestellt werden. Wird eine Lieferadresse angegeben, liefert Luxad direkt an diese Adresse. Ohne Angabe einer Lieferadresse kommt der Rahmen zu euch.
www.luxad.de/api/1.0/frameshop/
- aid Deine API-Id (erforderlich)
- aac API-Accesscode (erforderlich)
- do=setorder (erforderlich)
- fsid Die eindeutige Rahmen-ID "fsid" (erforderlich)
- pp=y Um Fotodruck zu bestellen
- pi Foto-ID, Artikelnummer (URL-Kodiert) (erforderlich bei Fotodruck)
- op Bearbeiter E-Mail-Adresse (URL-Kodiert)
- opn Bearbeiter Name (URL-Kodiert)
- shr Versandtarif (z.B. DHL2Deutschland oder PICKUP) (erforderlich)
- detp=y Sonderfall: Packstation
- dec Lieferadresse Firma oder Postnummer (URL-Kodiert)
- deg Lieferadresse Anrede (URL-Kodiert)
- det Lieferadresse Titel (URL-Kodiert)
- def Lieferadresse Vorname (URL-Kodiert)
- del Lieferadresse Nachname (URL-Kodiert)
- des Lieferadresse Straße und Nr. oder Packstation 124 (URL-Kodiert)
- depl Lieferadresse PLZ (URL-Kodiert)
- deci Lieferadresse Ort (URL-Kodiert)
- deco Lieferadresse Land (URL-Kodiert)

Klartext:
https://www.luxad.de/api/{API-Version}/frameshop/?aid={API-ID}&aac={API-Accesscode}&do=setorder&fsid={Eindeutige Bilderrahmen-Nummer}&pp={Fotodruck y/n}&pi={Artikelnummer vom bestellten Foto}&op={Bearbeiter E-Mail-Adresse}&opn={Bearbeiter Vor- und Nachname}&shr={Versandtarif}&detp={Lieferung an Packstation}&dec={Lieferadresse Firmenname}&deg={Lieferadresse Anrede}&det={Lieferadresse Titel}&def={Lieferadresse Vorname}&del={Lieferadresse Nachname}&des={Lieferadresse Straße und Nummer oder Packstation 123}&depl={Lieferadresse PLZ}&deci=(Lieferadresse Ort)&deco={Lieferadresse Land}

Beispiel (mit Fotodruck und Abholung im Luxad):
https://www.luxad.de/api/1.0/frameshop/?aid=demo&aac=[API-Accesscode]&do=setorder&fsid=12345&pp=y&pi=2014-X1-1245&shr=PICKUP

Beispiel (ohne Fotodruck, mit speziellem Bearbeiter und Lieferung an Kunden):
https://www.luxad.de/api/1.0/frameshop/?aid=demo&aac=[API-Accesscode]&do=setorder&fsid=12345&op=max%40euershop.de&deg=Frau&def=Anja&del=Hinundweg&des=Schlossstr.+1&depl=12345&deci=Berlin&deco=Deutschland&shr=DHL2Deutschland

Ausgabe:
Die API antwortet direkt mit einer Ausgabe auf den Bestelleingang und übermittelt folgende Werte:
Auftragsnummer; Auftragswert; URL zum Freigeben; URL zum Stornieren.
Parallel wird eine E-Mail (an die verknüpfte oder angegebene) versendet.

Auftragsstatus abfragen (do=getorderstatus)

Liefert den aktuellen Stand zu einem bestimmten Autrag.
www.luxad.de/api/1.0/frameshop/
- aid Deine API-Id (erforderlich)
- do =getorderstatus (erforderlich)
- t Auftragsnummer (erforderlich)
- e Besteller E-Mail-Adresse (erforderlich)

Klartext:
https://www.luxad.de/api/{API-Version}/frameshop/?aid={API-ID}&do=getorderstatus&t={Auftragsnummer, die von der API übermittelt wurde}&e={E-Mail-Adresse, die bei der Bestellung verwendet wurde}

Aufruf:
https://www.luxad.de/api/1.0/frameshop/?aid=demo&do=getorderstatus&t=234235345345345345&e=deine@email.de

Ausgabe:
Die API antwortet mit dem aktuellen Stand:
PENDING;URL zum Bestätigen; URL zum Stornieren (Wartet)
OPEN (Angenommen)
PROGRESS (In Bearbeitung)
SHIPPED;Sendungsnummer (Versendet)
COMPLETED (Abgeschlossen)
CANCELLED (Storniert)

Integration

Logistik/Organisation

Luxad hat jahrelange Erfahrung mit perfekten Fotodrucken, dem Einrahmen von Werken in die Bilderrahmen und den optimierten Versand von einem oder mehreren Bilderrahmen.
Diese Erfahrung ist als Option zu verstehen. So können Fotos direkt im Luxad gedruckt und auch der Bilderrahmen an den Kunden gesendet werden - sofern gewünscht!
Um eine Idee zu bekommen - viele Bestellungen sind innerhalb einer Stunde nach Bestellung verpackt und versandfähig. Viele Bestellungen erreichen bereits am Folgetag den Empfänger.

Technisch

Der Aufwand für erfahrene ProgrammiererInnen hält sich in Grenzen. Die API und ihre Daten sind so aufgebaut, dass sich verschiedene Möglichkeiten ergeben. Daher ist ein Konzept unbedingt erforderlich. Stellt vorher klar, wie der Frameshop eingebunden werden soll.
Hier ein Leitfaden für Programmierer zum Download (.pdf).

Buchhaltung

- Eure Buchhaltung schreibt die Rechnung an den Kunden.
- Für Leistungen von Luxad erhaltet ihr eine (Sammel)-Rechnung.