Spedmo-REST-API

Möchten Sie einige Funktionen von Spedmo in Ihrer eigenen Anwendung verwenden? Dann sind Sie bei uns genau richtig.

Die Spedmo-REST-API ermöglicht externen Anwendungen und Websites die Integration in Spedmo-Daten und -Dienste. Die API kann kostenlos verwendet werden und eine vollständige Definition der bereitgestellten Services finden Sie in unserer Swagger UI API-Spezifikationsschnittstelle, die auch eine nützliche Testumgebung für das Testen und die Fehlerbehebung von API-Funktionen bietet.

Anfangen

1. Erhalte einen API-Schlüssel (SPEDMO-API-KEY)

Bevor Sie die API für Ihre Anwendung verwenden, muss ein API-Schlüssel generiert werden, der den Mechanismus zur Identifizierung Ihrer Aufrufe der API von anderen Anwendungen bereitstellt. Melden Sie sich zunächst mit Ihrem Konto bei Spedmo an, und Ihr API-Schlüssel kann über die API-Verwaltungskonsole generiert werden.

Ihr API-Schlüssel wird eine UUID sein und wird " SPEDMO-API-KEY " genannt, wenn er für Transaktionen mit dem Dienst verwendet wird.

2. Testen Sie, ob der Schlüssel mit der API funktioniert

Die Spedmo REST Swagger UI- API-Spezifikationsschnittstelle ermöglicht schnelles und einfaches Testen der API im Web, ohne dass benutzerdefinierte Software konfiguriert werden muss. Sie können sie als schnelles und einfaches Debugging-Tool für potenzielle Integrationsprobleme mit Ihrer Anwendung verwenden .

Mit Ihrem API-Schlüssel sollten Sie in der Lage sein, News.api zu testen und zu überprüfen, ob Ihr Schlüssel Ihnen erlaubt, eine Antwort vom System zu erhalten. Geben Sie einfach Ihren Schlüssel in das Gurtzeug ein und klicken Sie auf " Ausprobieren! ". Wenn der Test erfolgreich war und der Inhalt zurückgegeben wurde, können Sie Funktionen in Ihre App integrieren.

Alternativ dazu kann die API auch mit einer Anwendung wie CURL wie im folgenden Beispiel gezeigt verwendet werden.

curl -X GET --header 'Akzeptieren: application / json' --header 'SPEDMO-API-SCHLÜSSEL: IHR-SCHLÜSSEL-HIER ' 'https://www.spedmo.com/api/v1.0/news.api "

Wenn Ihr Schlüssel kein Ergebnis zurückgibt, überprüfen Sie, ob Sie die obigen Anweisungen korrekt befolgt haben.

3. Beziehen eines Benutzerschlüssels, um persönliche Daten zu erhalten (SPEDMO-ACCESS-KEY)

Für die Hauptfunktionen der REST-API wird ein Benutzerschlüssel benötigt, um persönliche Daten wie Benutzerkontaktdetails und Benutzerbeiträge (Flüge, Livetracks usw.) zu lesen. Dieser Schlüssel wird erhalten, indem ein Benutzer aufgefordert wird, Zugriff auf Ihre Anwendung zu gewähren. Der einmal erlangte Schlüssel ist auf unbestimmte Zeit gültig. Es besteht keine Notwendigkeit, diesen Schlüssel erneut anzufordern, sobald Ihre Anwendung ihn erhalten hat App oder Dienst.

Um dem Benutzer die Anfrage zu präsentieren, zeigen Sie einfach die folgende URL in Ihrer Anwendung https://www.spedmo.com/apiAuthorise.pg an und stellen Sie Ihren " SPEDMO-API-KEY " im Anforderungsheader bereit . Wenn Sie die Spedmo-Navigation aus dem Erlebnis entfernen möchten, fügen Sie einfach whitelabel = true als Anforderungsparameter hinzu.

curl -X GET --header 'Akzeptieren: application / json' --header 'SPEDMO-API-SCHLÜSSEL: IHR-SCHLÜSSEL-HIER ' 'https://www.spedmo.com/apiAuthorize.pg?whitelabel=true'

Die Antwort wird als HTML zurückgegeben und sollte direkt dem Benutzer angezeigt werden. Ein Beispiel für die erwartete Ausgabe wird im Diagramm unten gezeigt.

Telefon-API

Spedmo kümmert die Benutzer Eingaben zu verarbeiten, sollte die Anwendung Seite Response - Header und suchen Sie nach dem „SPEDMO-ACCESS-KEY“ überwachen. Dieser Schlüssel in Verbindung mit Ihrem " SPEDMO-API-KEY " ermöglicht Ihrer Anwendung, die vollen Funktionen der Spedmo REST API zu nutzen.

4. Testen Sie, dass ein Benutzerschlüssel mit der API funktioniert

Mit Ihrem Benutzerschlüssel erhalten Sie Benutzerinformationen mit Member.api .

curl -X GET --header 'Akzeptieren: application / json' --header 'SPEDMO-ZUGRIFFSSCHLÜSSEL: USER-KEY-HERE ' --header 'SPEDMO-API-SCHLÜSSEL: IHR-SCHLÜSSEL-HIER ' 'https: / /www.spedmo.com/api/v1.0/member.api '

Informationen zu allen anderen REST API-Funktionen finden Sie in der Swagger UI API-Spezifikation.