RetailForce Cloud API
RetailForce Cloud API udostępnia wszystkie funkcje RetailForce Cloud Portal. Można go wykorzystać do automatyzacji procesów lub wywoływania funkcji z systemów zewnętrznych bez konieczności logowania się do portalu i ręcznego wykonywania czynności.
Uwierzytelnianie
Aby korzystać z tych funkcji, system wysyłający żądanie musi uwierzytelnić się w systemie Cloud. Poniżej opisano uwierzytelnianie ręczne, a także przedstawiono przykłady wywołań sterowanych zdarzeniami.
Dostęp poprzez api.RetailForce Cloud
Cloud API jest dostępny pod następującym adresem URL:
Uwierzytelnianie ręczne
Uwierzytelnianie odbywa się za pomocą parametrów cloudApiKey i cloudApiSecret oraz poprzez wygenerowanie tokenu typu „Bearer”.
1. Punkt końcowy wywołania
- Proszę kliknąć punkt końcowy
POST /api/v1.0/authenticate/logon, aby rozwinąć tę sekcję. - W odpowiednich polach wprowadź swoje
apiKeyorazapiKeySecret. - Wykonaj żądanie, aby otrzymać token typu Bearer.
2. Wykorzystanie tokenu Bearer
- Skopiuj token Bearer z treści odpowiedzi (ResponseBody).
- Proszę kliknąć przycisk „Autoryzuj” w prawym górnym rogu interfejsu Swagger UI.
- Wprowadź token Bearer w oknie dialogowym. Format:
Bearer <token>(proszę wstawić spację po słowie „Bearer”). - Kliknij „Autoryzuj”
Uwierzytelnianie automatyczne
Automatyczne uwierzytelnianie umożliwia systemom bezpieczny dostęp do RetailForce Cloud API bez konieczności interakcji ze strony użytkownika, co stanowi idealne rozwiązanie dla usług działających w tle, zautomatyzowanych przepływów pracy lub regularnych zapytań o dane.
1. Uwierzytelnianie i otrzymanie tokenu Bearer:
Należy wysłać żądanie POST wraz z danymi uwierzytelniającymi api do punktu końcowego uwierzytelniania.
curl -X POST "https://api.retailforce.cloud/api/v1.0/authenticate/logon" \
-H "Content-Type: multipart/form-data" \
-F "key=cloudApiKey" \
-F "secret=cloudApiSecret"
Po pomyślnym uwierzytelnieniu w treści odpowiedzi (ResponseBody) otrzymają Państwo token typu „Bearer”, który jest wymagany do autoryzacji kolejnych żądań api.
2. Dostęp do punktów końcowych:
Proszę użyć otrzymanego tokenu typu „Bearer” w celu uzyskania dostępu do punktów końcowych.
Przykład:
curl -X 'GET' \
'https://api.retailforce.cloud/api/v1.0/someEndpoint' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {yourBearerToken}'
Ważne: Prosimy o bezpieczne przechowywanie danych uwierzytelniających api oraz tokenów, aby zapobiec nieuprawnionemu dostępowi.
Fiskalizacja w Cloud
Termin „Fiskalizacja w chmurze” odnosi się do udostępniania middleware RetailForce do fiskalizacji w formie hostowanej usługi w chmurze. Usługa ta jest obsługiwana przez firmę RetailForce w środowisku chmury obliczeniowej.
Dostęp poprzez stronę fiscalisation.retailforce.cloud/cloud
Dostęp do usługi można uzyskać za pośrednictwem poniższego linku:
Ręczne uwierzytelnianie
Istnieją dwie opcje uwierzytelniania w usłudze RetailForce Cloud Fiscalization za pośrednictwem interfejsu Swagger UI:
- Proszę otworzyć interfejs Swagger UI i kliknąć przycisk „Autoryzuj”.
- Metody uwierzytelniania
- Dane logowania do portalu (adres e-mail i hasło):
- Umożliwiają dostęp do wielu organizacji.
- Klucz API i sekret:
- Zazwyczaj powiązane z konkretnym distributorem lub organizacją.
- Dane logowania do portalu (adres e-mail i hasło):
- Proszę kliknąć „Autoryzuj”
Ma Pan/Pani teraz uprawnienia do przetestowania i rozpoczęcia korzystania z usługi fiskalizacji w Cloud.
Ten artykuł został przetłumaczony automatycznie.
Komentarze
Komentarze: 0
Zaloguj się, aby dodać komentarz.