Strona może być nieaktualna
Nikt jej nie zmieniał od 59 miesięcy (ostatni commit: 2021-11-23, kaatarzyna). Jeśli opisuje stan, którego już nie ma, zgłoś ją jako nieaktualną.
Integracja z platformą Semmelrock¶
Proces¶
Proces tworzenia zlecenia na platformie Apollo z poziomu platformy Semmelrock wygląda nastepująco:
- Semmelrock pyta o propozycje wolnych okien,
- Apollo je zwraca,
- użytkownik w Semmelrocku wybiera sobie którąś z propozycji i klika "OK",
- w Apollo tworzy się zlecenie z oknem czasowym w wybranym terminie.
Komunikaty¶
Logowanie¶
Dokładne informacje nt. komunikatu logowania można znaleźć w API.md w sekcji Autoryzacja.
Poniżej przykładowy komunikat i przykładowa odpowiedź - uzyskany w odpowiedzi token służy do autoryzacji kolejnych zapytań:
Request:
POST http://apollo.logintegra.com/apollo/api/login
Content-Type: application/json
APIVersion: v1
{
"username": "semmelrock-admin",
"password": "hasło"
}
Response:
{
"username": "semmelrock-admin",
"roles": [
"ACCESS_TO_TRANSPORT_DETAILS",
(..)
],
"token_type": "Bearer",
"access_token": "r78rdcvnmgpf6f767ae4rigvkagql4nj"
}
Pytanie o wolne okna¶
Dokładne informacje nt. komunikatu sprawdzającego pierwsze wolne miejsca na okno czasowe można znaleźć w API.md w sekcji Zapytanie o propozycję wolnych okien.
Przykładowe testowe zapytanie (wraz z mechanizmem autoryzacji) można znaleźć w find-suggested-slots.http.
Poniżej przykładowe zapytanie i odpowiedź.
Request:
POST http://apollo.logintegra.com/apollo/api/time-windows/suggest
Content-Type: application/json
APIVersion: v1
Authorization: Bearer <token>
{
"principalCompany": {
"id": "",
"alias": "semmelrock"
},
"transportType": {
"id": "",
"alias": "LOADING"
},
"warehouse": {
"id": "",
"name": "Magazyn Gdynia"
},
"searchStart": "2021-08-05T12:00:00Z",
"searchStop": "2021-08-05T17:00:00Z"
}
Response:
{
"slots": [
{
"start": "2021-08-05T12:00:00Z",
"stop": "2021-08-05T13:00:00Z",
"ramp": {
"id": 222498499,
"warehouse": {
"id": 222498476,
"name": "Magazyn Gdynia"
},
"name": "1/A",
"shortName": "1/A"
}
},
{
"start": "2021-08-05T12:00:00Z",
"stop": "2021-08-05T13:00:00Z",
"ramp": {
"id": 222498595,
"warehouse": {
"id": 222498476,
"name": "Magazyn Gdynia"
},
"name": "2/A",
"shortName": "2/A"
}
},
{
"start": "2021-08-05T12:00:00Z",
"stop": "2021-08-05T13:00:00Z",
"ramp": {
"id": 222498563,
"warehouse": {
"id": 222498476,
"name": "Magazyn Gdynia"
},
"name": "3/A",
"shortName": "3/A"
}
}
]
}
Tworzenie zlecenia wraz z danymi awizacji i oknem czasowym¶
Semmelrock tworzy zlecenie od razu z oknem czasowym i danymi awizacji. Dokładne informacje na temat tych komunikatów można znaleźć w API.md w sekcjach Tworzenie transportu, Edycja istniejącego transportu, Dodanie/edycja awizacji, Dodanie/edycja okna czasowego.
Szablony komunikatów testowych można znaleźć w create-transport.http oraz update-transport.http.
Poniżej przykładowe zapytanie - w odpowiedzi wysyłane są dane utworzonego transportu.
POST http://apollo.logintegra.com/apollo/api/transports
Content-Type: application/json
APIVersion: v1
Authorization: Bearer <token>
{
"erpIdentifier": "2111447",
"altIdentifier": "2111447",
"description": "Uwaga: Załadunek tylko bokiem",
"tradesman": "",
"carrierCompany": {
"id": "225680008",
"contractorNumber": "",
"shortName": ""
},
"principalCompany": {
"id": "",
"alias": "semmelrock"
},
"transportType": {
"id": "",
"alias": "DELIVERY"
},
"advice": {
"driverName": "GRAD PIOTR",
"carRegistrationNumber": "WGM11150",
"trailerRegistrationNumber": "WZ2303R",
"documentNumber": "ATD212324",
"documentType": "ID_CARD",
"driverMobilePhoneNumber": "600284363",
"driverMobilePhonePrefix": "48",
"personalDataProcessingConsent": "true",
"termsOfConditionsAccepted": "true"
},
"steps": [
{
"stepTypeName": "load",
"orderInTransport": "0",
"warehouse": {
"id": "",
"idx": "",
"name": "Magazyn Gdynia"
},
"company": {
"id": "225680053",
"contractorNumber": "",
"shortName": ""
},
"timeWindow": {
"ramp": "1/A",
"start": "2021-08-09T13:30:00Z"
}
}
],
"customFieldValues": [
{
"definitionName": "Typ zlecenia",
"value": "Załadunek"
},
{
"definitionName": "ID zlecenia TMS",
"value": "98887"
}
]
}
Uwaga: Węzeł company w sekcji step jest opcjonalny.
W przypadku poprawnego utworzenia zlecenia w odpowiedzi zostaną odesłane dane utworzonego transportu.
W przypadku gdy w żądanym miejscu będzie już istniało okno czasowe zostanie odsłany komunikat:
{
"errors": [
{
"status": {
"enumType": "org.springframework.http.HttpStatus",
"name": "UNPROCESSABLE_ENTITY"
},
"title": "WindowsOverlapException",
"detail": "Nie możemy zarezerwować okna czasowego o długości 60 minut we wskazanym miejscu, ponieważ magazyn jest już zajęty w tych godzinach. Prosimy o wybranie innej godziny lub rampy.",
"meta": {
"exceptionType": "WINDOWS_OVERLAP_EXCEPTION",
"initialStart": "2021-08-09T13:30:00Z",
"windowSizeInMinutes": 60,
"rampName": "1/A"
}
}
]
}
Ostatnia zmiana: 2021-11-23 · kaatarzyna
Zbudowano: 2026-11-20 10:32 UTC · wersja 1.0.0 · rewizja: 19fcdc12e