Versions Compared

Old Version 10

changes.mady.by.user Marcel Pilger

Saved on

compared with

New Version Current

changes.mady.by.user Marcel Pilger

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Note

Hierbei handelt es sich um ein internes API, welches lediglich von der TruckBuddy App genutzt wird!

Übersicht

Technischen Informationen zur API

 

Status
colourGreen
titleGET
https://[RootUrl]/apiinfos

Liefert technische Informationen zur API

Registrierung

Status
colourBlue
titlePUT
  https://[BaseUrl]/truckBuddyAppInstances/{truckBuddyAppInstanceIdentifier}

Onboarding durch eine neue TruckBuddy APP Instanz.

Status
colourGreen
titleGET
  https://[BaseUrl]/truckBuddyAppInstances/{truckBuddyAppInstanceIdentifier}

Registrierungszustand einer bestimmten TruckBuddy App Instanz abfragen.

App Preferences

Status
colourBlue
titlePUT
  https://[BaseUrl]/truckBuddyAppInstances/{truckBuddyAppInstanceIdentifier}/preferences

Setzen oder aktualisieren der App Preferences.

Status
colourGreen
titleGET
https://[BaseUrl]/truckBuddyAppInstances/{truckBuddyAppInstanceIdentifier}/preferences

Abfragen der App Preferences.

URL's

API Root URL [RootUrl]

Hierbei handelt es sich um die Root URL von Q Directories bzw. des DirectoriesX-API's. 

...

Sie lautet beispielsweise: https://eu-api.q-directories.com/v7/

...

API Key

...

Für den Zugriff auf die in dem Dokument angeführten Endpunkte des API’s ist ein API-Key mit der Key-Role "directoriesXLogistics" notwendig.

...

Technische Informationen zur API

Status
colourGreen
titleGET
  https://[RootUrl]/apiinfos

Eine GET-Abfrage auf die API Root-Url liefert technische Informationen zur API. Aktuell handelt es sich hierbei um eine Liste der unterstützten API-Versionen. Ein Server kann gleichzeitig mehrere unterschiedliche Versionen des API unterstützen. Client-Systeme können hiermit zur Laufzeit prüfen, ob der angesprochene Server die benötigte Version des API anbietet.

Response

  • 200 - OK

Response Body
Code Block
{ 
 "supportedApiVersions": [
    {
      "version": "v7",
      "isDeprecated": false
    },
	{
      "version": "v6",
      "isDeprecated": true
    }
  ]
 //... 
}

Response Body(supportedApiVersions)

version
string(40)
required

Einzelne vom Cluster bzw. Server unterstützten API Versionen (Bsp: "v2")

isDeprecated
bool
default: false

Die angegebene Version ist veraltet und wird in absehbarer Zeit nicht mehr unterstützt. Dieser Hinweis erlaubt abhängigen Systemen, dem Anwender einen entsprechenden Hinweis anzuzeigen und ihn darauf hinzuweisen, dass ein Update des Systems notwendig ist.

...

Registrierung

Neue TruckBuddy APP Instanz registrieren

Status
colourBlue
titlePUT
  https://[BaseUrl]/truckBuddyAppInstances/{truckBuddyAppInstanceIdentifier}

...

Path Params

truckBuddyAppInstanceIdentifier
string(100)
required

Eindeutiger Identifier der TruckBuddy APP Instanz.

Request Body

phoneNumber
string(100)
required

Telefonnummer des Mobilgeräts im Format (E.164). Hierbei muss es sich um eine Mobilnummer handeln. Andernfalls wird der Aufruf mit einem Fehler abgelehnt.

tan
string(20)

Transaktionsnummer, um Mobilnummer zu authentifizieren. Dies geschieht im zweiten Schritt des Registrierungsablaufs.

disclaimerHash
string(100)

Hash der Nutzungsbedingungen, welche der Anwender im Zuge der Registrierung akzeptiert hat.

language
string(100)
required

Spracheinstellung der App bzw. des Anwenders. Es handelt sich um eine Kombination aus “<Language Code ISO-639-1>-<Country Code ISO-3166>”. Bsp: ‚de-DE' oder ‚en-GB'.

Response

  • 200 - OK Der jeweilige Registrierungsschritt wurde erfolgreich abgeschlossen.

Mögliche Fehler

Die angeführte TAN ist nicht korrekt und stimmt nicht mit der ursprünglichen TAN überein

In diesem Fall liefert der Aufruf einen Returncode "409 Conflict" mit dem nachfolgenden Fehlerobjekt:

Attribute

Value

errorIdentifier

TANValidationError

errorMessage

The TAN provided is incorrect and does not match the original TAN

reason

Registration refused

...

Registrierungszustand einer bestimmten TruckBuddy App Instanz abfragen

Status
colourGreen
titleGET
  https://[BaseUrl]/truckBuddyAppInstances/{truckBuddyAppInstanceIdentifier}

...

Path Params

truckBuddyAppInstanceIdentifier
string(100)
required

Eindeutiger Identifier des TruckBuddy APP Instanz.

Response

  • 200 - OK

Response Body (truckBuddyAppInstances)

status
string(20)
required

Aktueller Status der Registrierung:
'onboarding': Onboarding ist am Laufen, jedoch noch nicht abgeschlossen.
'registered': Onboarding ist abgeschlossen.

disclaimerHash
string(100)

Hash der Nutzungsbedingungen, welche der Anwender als letztes akzeptiert hat.

  • 404 - Not Found Für die angegebene Instanz gibt es noch keine Registrierung.

...

App Preferences

App Preferences setzen oder aktualisieren

Status
colourBlue
titlePUT
  https://[BaseUrl]/truckBuddyAppInstances/{truckBuddyAppInstanceIdentifier}/preferences

...

Path Params

truckBuddyAppInstanceIdentifier
string(100)
required

Eindeutiger Identifier der TruckBuddy APP Instanz.

Request Body

language
string(100)
required

Spracheinstellung der App bzw. des Anwenders. Es handelt sich um eine Kombination aus “<Language Code ISO-639-1>-<Country Code ISO-3166>”. Bsp: ‚de-DE' oder ‚en-GB'.

cultureInfo
string(100)
required

Regionseinstellung für die Formatierung von Datums- und Zahlen-Werten. Es handelt sich um eine Kombination aus “<Language Code ISO-639-1>-<Country Code ISO-3166>”. Bsp: ‚de-DE' oder ‚en-GB'.

Response

  • 200 - OK Preferences erfolgreich gespeichert.

...

App Preferences abfragen

Status
colourGreen
titleGET
https://[BaseUrl]/truckBuddyAppInstances/{truckBuddyAppInstanceIdentifier}/preferences

...

Path Params

truckBuddyAppInstanceIdentifier
string(100)
required

Eindeutiger Identifier der TruckBuddy APP Instanz.

Response

  • 200 - OK

Response Body (preferences)

language
string(100)
required

Spracheinstellung der App bzw. des Anwenders. Es handelt sich um eine Kombination aus “<Language Code ISO-639-1>-<Country Code ISO-3166>”. Bsp: ‚de-DE' oder ‚en-GB'.

cultureInfo
string(100)
required

Regionseinstellung für die Formatierung von Datums- und Zahlen-Werten. Es handelt sich um eine Kombination aus “<Language Code ISO-639-1>-<Country Code ISO-3166>”. Bsp: ‚de-DE' oder ‚en-GB'.

  • 404 - Not Found Für die angegebene Instanz ist unbekannt oder es gibt es noch keine Registrierung.