API-Dokumentation

Die Buywords-API stellt eine Programmierschnittstelle zum Buywords Marktplatz dar. Über diese ist es Ihnen möglich, ausgewählte Funktionen aus eigenen Programmen heraus abzurufen und somit in Ihre täglichen Geschäftsprozesse automatisiert einzubinden.

Voraussetzungen

Um Daten über die API von Ihrer Software aus aufrufen zu können, benötigen Sie einen Benutzeraccount (https://www.buywords.de/) und einen Zugangsschlüssel (siehe dazu den folgenden Abschnitt "˜Authentifizierung"). Darüber hinaus muss der Client von dem Sie den API-Request starten HTTP fähig sein.

Authentifizierung

Neben dem Benutzer Account ist der API-Key für den Zugriff auf die Service-Methoden der Schnittstelle erforderlich. Ihren persönlichen API-Schlüssel bekommen Sie vom Support. Haben Sie diesen Schlüssel, müssen Sie ihn bei jedem Zugriff auf die API als Wert im Parameter "key" mit übergeben.

Formatierung / Zeichensatz

Als Zeichensatz wird in der gesamten API UTF-8 verwendet. Die Rückgabedaten können in einem gewünschten (per Parameter "format" übergebenen) Format ausgegeben werden. Zur Wahl stehen die Formate JSON und XML. Die Funktion getPdf des Services Report unterstützt zusätzlich das Format PDF. Wird ein Format nicht explizit übergeben, werden die Rückgabedaten formatiert in JSON zurückgegeben.