Änderung der API-Benutzung

Für all diejenigen, die unsere Public API benutzen, gibt es ab Anfang 2018 ein paar wichtige Änderungen. Die Details erfährst Du in diesem Blogpost.

Fangen wir mit einer kurzen Zusammenfassung an: Ab Anfang 2018 müssen alle Applikationen, die unsere API verwenden … 

• … über HTTPS durchgeführt werden, 
• … die offiziellen Domains api.spreadshirt.com (NA-Plattform) und api.spreadshirt.net (EU-Plattform) verwenden.
• … einen gültigen API-Key mitschicken und 
• … einen User-Agent bereitstellen.

HTTPS

Sicher ist sicher: Alle Anfragen an unsere API müssen in Zukunft über HTTPS durchgeführt werden. Anfragen, die über HTTP durchgeführt werden, werden demnächst einfach auf HTTPS redirected.

Offizielle Domains

Wir machen es offiziell: Alle Anfragen müssen in Zukunft über unsere offiziellen Domains api.spreadshirt.net und api.spreadshirt.com durchgeführt werden. Andere Routen für die API-Benutzung werden dann geschlossen. Aus Sicherheitsgründen behalten wir uns auch vor, den Zugriff über inoffizielle Routen zu blocken.

API-Key

Alle Applikationen, die Anfragen an unsere API stellen, müssen einen gültigen API-Key mitschicken. Am einfachsten geht das, indem man an jede URL einen Query-Parameter mit dem API-Key anhängt wie zum Beispiel:

https://api.spreadshirt.net/api/v1/shops/205909?apiKey=8e5bb312-9060-446f-ada2-8c319327745a

Diese Variante werden wir zwar weiter unterstützen, empfehlen sie aber nicht mehr.

Besser ist es, den dafür vorgesehenen Authorization-Header zu verwenden (https://developer.spreadshirt.net/display/API/Security), wie zum Beispiel: 

• https://api.spreadshirt.net/api/v1/shops/205909
• Authorization: SprdAuth apiKey=”8e5bb312-9060-446f-ada2-8c319327745a”

Bei der Kommunikation über HTTPS wird der Header dann ebenfalls verschlüsselt übertragen.

API-Keys für unsere EU- und NA-Plattform kann man hier bekommen:

• https://www.spreadshirt.de/-C7120 
• https://www.spreadshirt.com/-C6840

User-Agent

Alle Applikationen, die nicht in einem Browser laufen, müssen in Zukunft zusätzlich einen gültigen User-Agent mitschicken, der es erlaubt, den API-Benutzer zu identifizieren. Der User-Agent muss wie folgt aussehen:

User-Agent: <DeineAnwendung>/<DeineAnwendungsversion> (https://www.deinedomain.com; deinname@deinedomain.com)

Beispielhaft sieht ein User-Agent so aus:

User-Agent: WordPress-Plugin/1.0 (https://www.deinblog.com; admin@deinblog.com)

Wenn ihr unser API verwendet, stellt bitte neben dem Anwendungsnamen und der Version auch die Domain und die E-Mail-Adresse des Administrators bereit. Damit wir im Notfall auch eine Chance haben, Kontakt aufzunehmen.

Wir hoffen, dass ihr mit den Änderungen genauso zufrieden seid, wie wir. Falls ihr noch Fragen oder Anregungen habt, dann sind wir natürlich für euch da.