RetailForce Cloud API

RetailForce Cloud API предоставя всички функции на RetailForce Cloud Portal. То може да се използва за автоматизиране на процеси или за извикване на функции от външни системи, без да се влиза в портала и да се извършват дейности ръчно.

Удостоверяване

За да използва функциите, системата, която отправя заявката, трябва да се удостовери пред Cloud системата. По-долу е описана ръчната автентификация, както и примери за извиквания, задействани от събития.

Достъп чрез api.retailForce.cloud

Cloud API е достъпен на следния URL адрес:

• https://api.retailforce.cloud/swagger/index.html

Ръчна автентификация

Удостоверяването се извършва чрез cloudApiKey и cloudApiSecret и генерирането на Bearer Token.

1. Крайна точка за извикване

1. Кликнете върху крайната точка POST /api/v1.0/authenticate/logon, за да разгънете секцията.
2. Въведете вашите apiKey и apiKeySecret в съответните полета.
3. Изпълнете заявката, за да получите Bearer Token.

2. Използване на Bearer Token

1. Копирайте Bearer Token от ResponseBody.
2. Кликнете върху бутона „Authorize“ в горния десен ъгъл на Swagger UI.
3. Въведете Bearer Token в диалоговия прозорец. Формат: Bearer <token> (поставете интервал след „Bearer“).
4. Кликнете върху „Authorize“

Автоматична автентификация

Автоматичната автентификация позволява на системите да имат сигурен достъп до RetailForce Cloud API без намеса от страна на потребителя, което е идеално за фонови услуги, автоматизирани работни потоци или редовни заявки за данни.

1. Удостоверяване и получаване на Bearer Token:

Изпратете POST заявка с вашите api идентификационни данни към крайната точка за удостоверяване.

curl -X POST "https://api.retailforce.cloud/api/v1.0/authenticate/logon" \
-H "Content-Type: multipart/form-data" \
-F "key=cloudApiKey" \
-F "secret=cloudApiSecret"

При успешна автентификация ще получите Bearer Token в ResponseBody, който е необходим за оторизиране на по-нататъшни api заявки.

2. Достъп до крайни точки:

Използвайте получения Bearer Token за достъп до крайните точки.

Пример:

curl -X 'GET' \
'https://api.retailforce.cloud/api/v1.0/someEndpoint' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {yourBearerToken}'

Важно: Пазете данните си за достъп до api и токените си на сигурно място, за да предотвратите неоторизиран достъп.

Cloud фискализация

„Облачна фискализация“ се отнася до предоставянето на middleware-то за фискализация на RetailForce като хоствана облачна услуга. Услугата се управлява от RetailForce в облачната среда.

Достъп чрез fiscalisation.retailforce.cloud

Достъпът до услугата се осъществява чрез следния линк:

• https://fiscalisation.RetailForce Cloud/swagger/index.html

Ръчна автентификация

Има две възможности за удостоверяване в RetailForce Cloud Fiscalization чрез Swagger UI:

1. Отворете Swagger UI и кликнете върху „Authorize“.
2. Методи за удостоверяване
   1. Удостоверителни данни за портала (имейл и парола):
      • Позволява достъп до множество организации.
   2. API ключ и API Secret:
      • Обикновено са свързани с конкретен distributor или организация.
3. Кликнете върху „Оторизирай“

Вече имате право да тествате и да започнете да използвате облачната фискализация.

Тази статия е преведена автоматично.