Download OpenAPI specification:Download
Wykonawcy współpracujący z firmą Emotivo mają do dyspozycji narzędzia wspomagające prace z voucherami oraz rezerwacjami. Obecnie dysponujemy trzema narzędziami, za pomocą których, można przeprowadzić czynności takie jak: sprawdzenie vouchera, dokonanie rezerwacji, ustawienia daty rezerwacji, anulowanie rezerwacji, realizację usługi oraz finalne rozliczenia. Są to:
Aplikacja mobilna oraz aplikacja www są tożsame, jeśli chodzi o funkcjonalności. W przypadku API, wykonawcy będą mogli używać endpointów do wszystkich funkcjonalności jak w dwóch pierwszych aplikacjach z wyjątkiem obszaru rozliczeń. Nasze systemy są unowocześniane - a wraz z nimi aplikacje, dlatego też pozostałe funkcjonalności w API będą pojawiać się w kolejnych wydaniach. Jeśli chcesz już dziś podzielić się z nami swoją opinią na temat naszego API - daj nam znać na adres arch_dev@emotivo.pl
Proces rezerwacji z perspektywy wykonawcy jest dość prosty, osoba obdarowana powinna pobrać dane o wykonawcy z systemów Emotivo a następnie skontaktować się z wybranym wykonawcą w celu umówienia rezerwacji. Pobranie danych o wykonawcy nie jest wymagane, osoba obdarowana może udać się do wykonawcy, bądź skontaktować z wykonawcą bez uprzedniego pobrania danych z systemów Emotivo.
Potwierdzenie terminu realizacji usługi - czyli rezerwacja - powinna być odłożona w systemie co będzie skutkowało zmianą stanu vouchera na "w rezerwacji". Wykonawca ma możliwość dodania do rezerwacji informacji o planowanej dacie realizacji, ale to też nie jest wymagane.
W momencie gdy voucher jest zarezerwowany, wykonawca ma możliwość odwołania rezerwacji, co skutkować będzie możliwością ponownego wejścia w proces.
Realizacja to zdarzenie które musi być zapisane w systemie, ponieważ na tej podstawie jesteśmy w stanie poprawnie wejść w podproces związany z rozliczeniem. Rozliczenie na ten moment jest obsługiwane z poziomu aplikacji mobilnej oraz aplikacji www.
Poniższy dokument stanowi dokumentację API dla wykonawców Emotivo. Udostępnia ono podstawowe operacje, które mogą być wykonane na voucherach z perspektywy wykonawcy czyli m.in. sprawdzenie vouchera, rezerwację vouchera, realizację vouchera oraz dodanie planowanej daty realizacji.
API dostępne jest pod adresem: https://api.emotivo.tech/v1/.
Lista kodów statusu HTTP, które mogą być zwrócone przez API:
Rodzaje kodów:
Poniższa tabela przedstawia listę kodów, które mogą być zwrócone przez API w polu messages
.
Kod | Opis |
---|---|
1000 | Ogólny kod powodzenia operacji (szczegółowe informacje w polu message) |
1001 | Raport został usunięty |
2000 | Ogólny błąd spowodowany nieprawidłowym zapytaniem (szczegółowe informacje w polu message) |
2001 | Obiekt nie istnieje (szczegółowe informacje w polu message) |
2002 | Nieprawidłowe dane uwierzytelniające |
2003 | Nieprawidłowy token API |
2004 | Token API stracił ważność |
3000 | Ogólny błąd w logice biznesowej (szczegółowe informacje w polu message) |
3001 | Nie można wykonać danej akcji dla vouchera o danym statusie (ogólny) |
3002 | Nie można wykonać danej akcji dla vouchera o statusie w rezerwacji |
3003 | Nie można wykonać danej akcji dla vouchera o statusie zrealizowany |
3004 | Nie można wykonać danej akcji dla vouchera o statusie rozliczony |
3005 | Nie można wykonać danej akcji dla vouchera o statusie zablokowany |
3006 | Nie można wykonać danej akcji dla vouchera o statusie przeterminowany |
3007 | Nie można wykonać danej akcji dla vouchera o danym typie (ogólny) |
3008 | Nie można wykonać danej akcji dla vouchera o typie karta podarunkowa |
3009 | Nie można wykonać danej akcji dla vouchera o typie box |
3010 | Voucher należy do innego wykonawcy |
4000 | Ogólny błąd wewnętrzny (szczegółowe informacje w polu message) |
4001 | Błąd w komunikacji z innym serwisem |
Logowanie i tworzonie tokenu
string Adres email wykonawcy | |
password | string Hasło wykonawcy |
{- "email": "admin@example.com",
- "password": "password"
}
{- "messages": [ ],
- "result": [
- {
- "auth_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZF91c2VyIjoxLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTUxNjMyNTQyMn0.WrT7joFtGu5Erp5cXzswrwMJM49iw0-w9n3BJexhAXk",
- "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZF91c2VyIjoxLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTUxNzQ0ODYyMn0.f_PULsFJJaZIg75ha-RtclGEwQatmonsyqxSbtL-iJk"
}
]
}
Odświeżenie tokenu
refresh_token | string Refresh token |
{- "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZF91c2VyIjoxLCJpYXQiOjE1MTYyMDkwMjIsImV4cCI6MTUxNjI5NTQyMn0.W5Ufikyo4XuaaKwZVKhU4J8mrTG4OFgRkuYjZXc1AlE"
}
{- "messages": [ ],
- "result": [
- {
- "auth_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZF91c2VyIjoxLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTUxNjMyNTQyMn0.WrT7joFtGu5Erp5cXzswrwMJM49iw0-w9n3BJexhAXk",
- "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZF91c2VyIjoxLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTUxNzQ0ODYyMn0.f_PULsFJJaZIg75ha-RtclGEwQatmonsyqxSbtL-iJk"
}
]
}
Zwraca listę voucherów przypisanych do wykonawcy.
status | string Enum: "realized" "in_reservation" "settled" Voucher status. |
plan_date_from | string Example: plan_date_from=2023‐06‐29T15:20:10+00:00 TODO |
plan_date_to | string Example: plan_date_to=2023‐06‐29T15:20:10+00:00 TODO |
page | integer Default: 1 Page number of paginated results. |
per_page | integer Default: 20 Maximum number of results per page. |
X-Auth-Token required | string Authentication token. |
{- "messages": [ ],
- "result": [
- {
- "number": "VABCDEFGHIJK123",
- "product_name": "Jazda za kierownicą Lamborghini Gallardo",
- "type": "single_use",
- "status": "in_reservation",
- "amount": 300,
- "sell_pipe": "PM",
- "create_date": "2023‐06‐29T15:20:10+00:00",
- "plan_date": "2023‐06‐30T15:20:10+00:00",
- "settlement_date": "2023‐06‐30T15:20:10+00:00",
- "expire_date": "2023‐06‐30T15:20:10+00:00"
}
], - "result_info": {
- "page": 1,
- "per_page": 20,
- "count": 20,
- "total_count": 400
}
}
Rezerwuje dany voucher.
X-Auth-Token required | string Authentication token. |
Optional description in Markdown
number | string Numer vouchera |
{- "number": "string"
}
{- "messages": [ ],
- "result": [ ]
}
Pobiera informacje o danym voucherze.
number required | integer Numer vouchera |
X-Auth-Token required | string Authentication token. |
{- "messages": [ ],
- "result": [
- {
- "number": "VABCDEFGHIJK123",
- "product_name": "Jazda za kierownicą Lamborghini Gallardo",
- "type": "TYPE_SINGLE_USE",
- "status": "in_reservation",
- "amount": 300,
- "sell_pipe": "PM",
- "create_date": "2023‐06‐29T15:20:10+00:00",
- "plan_date": "2023‐06‐30T15:20:10+00:00"
}
]
}
Wycofuje rezerwację i usuwa voucher od wykonawcy.
number required | integer Numer vouchera |
X-Auth-Token required | string Authentication token. |
{- "messages": [ ],
- "result": [ ]
}
Realizuje dany voucher.
number required | integer Numer vouchera |
X-Auth-Token required | string Authentication token. |
{- "messages": [ ],
- "result": [ ]
}
Przypisuje planowaną datę realizacji do vouchera.
number required | integer Numer vouchera |
X-Auth-Token required | string Authentication token. |
Optional description in Markdown
date required | string Planned date. |
{- "date": "2023‐06‐29T15:20:10+00:00"
}
{- "messages": [ ],
- "result": [ ]
}