„RetailForce Cloud“ API
„RetailForce Cloud API“ siūlo visas „Cloud Portal“ funkcijas. Tai leidžia automatizuoti procesus arba iš išorinių sistemų iškviesti funkcijas, nesiregistruojant portale ir nevykdant veiksmų rankiniu būdu.
Autentifikavimas
Norint naudotis funkcijomis, užklausą siunčianti sistema turi autentiškumo patvirtinimą atlikti „Cloud“ sistemoje. Toliau aprašomas rankinis autentiškumo patvirtinimas, taip pat pateikiami pavyzdžiai, kai iškvietimas vykdomas pagal įvykius.
Prieiga per api.retailForce.cloud
Debesų API prieinama per šį URL adresą:
Rankinis autentiškumo patvirtinimas
Autentifikavimas atliekamas naudojant CloudApiKey ir CloudApiSecret bei sukuriant Bearer Token.
1. Galutinio taško iškvietimas
- Spustelėkite galinį tašką „
POST /api/v1.0/authenticate/logon“, kad išplėstumėte šį skyrių. - Į atitinkamus laukelius įveskite savo „
apiKey“ ir „apiKeySecret“. - Vykdykite užklausą, kad gautumėte „Bearer“ žetoną.
2. „Bearer“ žymės naudojimas
- Nukopijuokite „Bearer“ žetoną iš „ResponseBody“.
- Spustelėkite mygtuką „Authorize“ (Autorizuoti) viršutiniame dešiniajame „Swagger UI“ kampe.
- Įveskite „Bearer“ žetoną dialogo lange. Formatas:
Bearer <token>(įterpkite tarpelį po žodžio „Bearer“). - Spustelėkite „Authorize“
Automatinis autentifikavimas
Automatinis autentifikavimas leidžia sistemoms saugiai prisijungti prie „RetailForce Cloud API“ be vartotojo įsikišimo, todėl tai idealiai tinka foninėms paslaugoms, automatizuotiems darbo srautams ar reguliariems duomenų užklausimams.
1. Autentiškumo patvirtinimas ir „Bearer“ žymos gavimas:
Siųskite POST užklausą su savo API prisijungimo duomenimis į autentifikavimo galinį tašką.
curl -X POST "https://api.retailforce.cloud/api/v1.0/authenticate/logon" \
-H "Content-Type: multipart/form-data" \
-F "key=cloudApiKey" \
-F "secret=cloudApiSecret"
Sėkmingai atlikus autentiškumo patvirtinimą, „ResponseBody“ gausite „Bearer“ žetoną, kuris reikalingas tolesnių API užklausų autorizavimui.
2. Prieiga prie galinių taškų:
Naudokite gautą „Bearer“ žetoną, kad galėtumėte pasiekti galinius taškus.
Pavyzdys:
curl -X 'GET' \
'https://api.retailforce.cloud/api/v1.0/someEndpoint' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {yourBearerToken}'
Svarbu: saugokite savo API prisijungimo duomenis ir žetonus, kad išvengtumėte neteisėtos prieigos.
Debesų fiskalizacija
„Debesų fiskalizacija“ reiškia „RetailForce“ fiskalizacijos tarpinės programinės įrangos teikimą kaip hostuojamą debesų paslaugą. Šią paslaugą debesų aplinkoje teikia „RetailForce“.
Prieiga per fiscalisation.retailforce.cloud
Naudodamiesi šia nuoroda galite prisijungti prie paslaugos:
Rankinis autentifikavimas
Autentiškumui patvirtinti „RetailForce Cloud Fiskalisierung“ per „Swagger UI“ yra dvi galimybės:
- Atidarykite „Swagger UI“ ir spustelėkite „Authorize“.
- Autentifikavimo metodai
- Portalo prisijungimo duomenys (el. paštas ir slaptažodis):
- Leidžia prisijungti prie kelių organizacijų.
- API raktas ir slaptažodis:
- Dažniausiai susieti su konkrečiu platintoju ar organizacija.
- Portalo prisijungimo duomenys (el. paštas ir slaptažodis):
- Spustelėkite „Authorize“
Dabar turite teisę išbandyti ir pradėti naudoti „Cloud-Fiskalisierung“.
Komentarai
0 komentarų
Tam, kad paliktumėte komentarus prisijunkite