REST-API-Dokumentation

(Vorläufige Version)

Vorgefertigte PHP-Dateien gibt es hier: https://git.fphst.de/FPH/SpedV-REST-PHP

Eine .NET Library ist hier zu finden: https://www.nuget.org/packages/FPH.SpedV.REST/ Alternativ: https://git.fphst.de/FPH/SpedV-REST-Net

JavaScript/Typescript Dateien für den Browser/NodeJS gibt es hier: https://www.npmjs.com/package/spedv-rest Alternativ: https://git.fphst.de/FPH/SpedV-REST-JS

Endpunkt:

https://api.sped-v.de/rest/api?apikey=APIKey&function=Funktion

Funktionen:

• getpositions (ohne API-Key Parameter, optional weiterer Parameter id (Spedition), optional weiterer Parameter sp (Singleplayer mitanzeigen)): Ruft eine Liste mit Koordinaten aller aktuell fahrenden Nutzer ab.
• getuserprofile (weiterer Parameter id): Gibt das Userprofil eines Nutzers zurück.
• getuserprofiles: Gibt Userprofile von Nutzern aus der Spedi aus.
• getonlineusers: Ruft eine Liste der aktuell angemeldeten Nutzer ab.
• getusers (optional Parameter includePartnerships (User aus Partnerschaften mitanzeigen)): Gibt alle Nutzer der Spedition zurück
• getuserstats: Gibt die Nutzerstatistik zurück
• getranks: Gibt (mit entsp. Rechten) die Ränge der Spedi aus
• getbranches: Gibt (mit entsp. Rechten) die Niederlassungen der Spedi aus
• gettrucks: Gibt (mit entsp. Rechten) die LKWs der Spedi aus
• gettasks: Gibt alle Aufträge der Spedi aus
• gettask (weiterer Parameter id): Gibt genauere Informationen zu einem Auftrag zurück
• gettaskdrivedata (weiterer Parameter id): Gibt den Fahrtverlauf eines Auftrags zurück.
• getsped: Gibt vollständige Speditionsinfos aus
• getspedmoney (optional Parameter includePartnerships (Konten aus Partnerschaften mitanzeigen)): Gibt (mit entsp. Rechten) die Bankkonten der Spedi aus
• getspedpartnerships: Gibt die Partnerschaften der Spedition zurück
• getspedtarget: Gibt das Speditionsziel aus
• getspedstats: Gibt Speditionsstatistiken aus
• getvacations: Gibt (mit entsp. Rechten) Urlaube aus
• gettrucktypes: Gibt alle vorhandenen LKW-Typen aus
• getacttask: Gibt den aktuellen Auftrag des angemeldeten Nutzers aus
• getownconvoyinfo: Gibt vollständige Fahrtdaten des angemeldeten Nutzers aus
• whoami: Gibt zurück, zu wem der API-Key gehört
• getmyrank: Gibt den Rang des angemeldeten Nutzers zurück.
• getsystemstats: Gibt Systemstatistiken aus.
• getkontorbranchs (weiterer Parameter map, optional weiterer Parameter includePartnerships (Lager aus Partnerschaften mitanzeigen)): Gibt die Kontor Lager aus.
• getkontortrailers (weiterer Parameter map, optional weiterer Parameter includePartnerships (Trailer aus Partnerschaften mitanzeigen)): Gibt die Kontor Trailer aus.
• getkontoroffers (weiterer Parameter map): Gibt das Kontor Auftragsangebot aus.
• getkontorofferparts (weiterer Parameter map, optional weiterer Parameter includePartnerships (Angebot aus Partnerschaften mitanzeigen)): Gibt das Kontor Fahrtangebot aus.
• getkontorspedoffers (weiterer Parameter map): Gibt die Kontor Aufträge der Spedition aus.
• getkontorspedparts (weiterer Parameter map, optional weiterer Parameter includePartnerships (Fahrten aus Partnerschaften mitanzeigen)): Gibt die Kontor Fahrten der Spedition aus.
• getkontormaps: Gibt die unterstützten Karten des Kontor Modus aus.
• getcountries: Gibt alle vorhandenen Länder aus.
• getchats: Gibt alle Chats des angemeldeten Nutzers zurück.
• getchatmessages (weiterer Parameter id): Gibt die Nachrichten eines Chats zurück.
• getspedchat: Gibt den Speditionschat des angemeldeten Nutzers zurück.