API Informationen

SpotCargoHub API – Übersicht

Die SpotCargoHub API ermöglicht den direkten Datenaustausch zwischen Transportmanagement-Systemen (TMS), ERP-Systemen und der SpotCargoHub-Plattform. Mit einer aktiven API-Anbindung können Transportanfragen, Angebote und Statusdaten automatisiert erstellt, abgerufen oder aktualisiert werden – ganz ohne manuelle Dateneingaben.

Vorteile der API

 

Automatisierte Datenaustausch

Transportanfragen, Angebote und Aufträge werden ohne manuelle Eingabe zwischen SpotCargoHub und dem internen System übertragen – fehlerfrei und in Echtzeit.

Schnellere Reaktionszeiten im Tagesgeschäft

Anfragen und Angebote werden automatisch übermittelt und verarbeitet, was zu schnelleren Entscheidungen und höherer Wettbewerbsfähigkeit führt.

Bessere Datenqualität & Transparenz

Einheitliche Datenhaltung zwischen TMS, ERP und SpotCargoHub – alle Beteiligten sehen jederzeit den gleichen Informationsstand.

Skalierbare, zukunftssichere Prozesse

Neue Kunden, Systeme oder Module lassen sich flexibel integrieren, ohne bestehende Abläufe anzupassen – die API wächst mit den Anforderungen.

 

 

Basisinformationen

Die SpotCargoHub API ist über HTTPS erreichbar und verwendet das JSON-Format für den Datenaustausch. Für Tests steht eine isolierte Sandbox-Umgebung zur Verfügung. Die Kommunikation erfolgt ausschließlich über sichere Verbindungen (HTTPS).

 

Base-URLs

 

Umgebung

Base-URL

Zweck

Produktion

https://app.spotcargohub.net/spedOnline/

Live-Daten

Sandbox

https://uat-app.spotcargohub.net/spedOnline/

Testumgebung für Entwickler

Authentifizierung

Die SpotCargoHub API ist durch einen individuellen (User-gebundenen) API-Key geschützt. Der Schlüssel muss im Header jeder API-Anfrage übermittelt werden. Zusätzlich sind die Header-Felder Content-Type und Accept erforderlich, um die Daten korrekt zu übertragen.

 

Erforderliche Header

 

Header

Wert

Beispiel

spotcargohubApiKey

Ihr API-Schlüssel

SCHEXAMPLE-1234-5678

Content-Type

application/json

application/json

Accept

application/json

application/json

Wichtige Endpoints

Im Folgenden findest Du eine Übersicht zentraler API-Routen. Diese Endpunkte ermöglichen u. a. das Platzieren von Angeboten, das Abrufen von Angebotsdetails sowie das Prüfen der API-Verfügbarkeit.

 

Übersicht API-Endpunkte

 

Ressource

Endpoint

Methode

Beschreibung

Angebot abgeben

/offer/placeOfferForRequest

PUT

Angebot zu einer Anfrage senden

Angebotsdetails

/offer/showOfferDetails

GET

Angebotsinformationen abrufen

Healthcheck

/health

GET

API-Erreichbarkeit prüfen

 

Direkte Links zur Swagger-Dokumentation

Sandbox & Testzugang

In unserer Sandbox-Umgebung kannst Du API-Aufrufe gefahrlos testen. Diese Umgebung ist ideal für Entwickler und Systemintegratoren, die eigene Schnittstellen testen oder Proof-of-Concepts umsetzen.

Diese Umgebung ist vollständig von den Live-Daten getrennt und enthält Testobjekte, mit denen Du ohne Risiko arbeiten kannst.

Hinweis:

Für den Zugriff auf die Sandbox benötigst Du einen separaten API-Key.

Diesen erhältst Du auf Anfrage per E-Mail an: support@spotcargohub.com

Fehler- und Statuscodes

Die API verwendet standardisierte HTTP-Statuscodes zur Rückmeldung von Erfolgen und Fehlern. Die folgende Tabelle bietet eine Übersicht der wichtigsten Codes:

Code

Bedeutung

Beschreibung

200

OK

Anfrage erfolgreich

400

Bad Request

Eingabe fehlerhaft

401

Unauthorized

API-Key fehlt oder ist ungültig

403

Forbidden

Keine Berechtigung für diese Aktion

404

Not Found

Angeforderte Ressource nicht gefunden

weitere Statuscodes und Fehlerdetails findest Du in der Swagger-Dokumentation.

Entwickler-Ressourcen

Für eine tiefergehende technische Dokumentation und Unterstützung stehen Dir folgende Ressourcen zur Verfügung:

Kontakt & Partnerintegration

Du hast Fragen zur API-Integration oder benötigst Unterstützung bei der technischen Anbindung?

Unser Technik-Team steht Dir gerne zur Seite.

 

Kontakt: