Изменения

Перейти к навигации Перейти к поиску

API Authorization

4556 байт добавлено, 02:51, 17 февраля 2024
API Авторизации
==Обзор==''Данный документа описывает методы для работы метод авторизации поставщика/дистрибьютора с системой в системе Smart Satu.''
ВерсияVersion Авторизация пользователя в систему Smart Satu происходит путем отправки POST-запроса с логином и паролем пользователя в JSON-теле по URL: 1https://food.smartsatu.com/api/users/login.0Headers в данном запросе не могут быть пустыми и должны содержать: "content-type: application/json; charset=utf-8" и "country: ru".0
Контактная информацияДалее на стороне сервера происходит валидация данных пользователя. В случае корректности данных сервер выдает JSON-тело ответа, которое содержит данные пользователя с уникальным токеном авторизации, который в дальнейшем будет использоваться в каждом последующем запросе к системе Smart Satu.
Contact : [[info@smartsatu.com]]'''Версия'''
URI схемаHost ''Version'': //smartsatu1.com/api/user/  Schemes : HTTPS0.0
Методы'''Контактная информация'''
''Contact'': [[info@smartsatu.com]]
Авторизация пользователя.'''URI схема'''
POST ''Host : /login /login.smartsatu.com/api/user/login  Schemes : HTTPS''
Описание==Методы=='''Авторизация пользователя'''
Метод для авторизации пользователя в системе Smart SatuPOST /api/user/login 
===Описание===
Метод для авторизации пользователя в системе Smart Satu.
 
Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu. В ответ на запрос авторизации приходит параметр - access_token_expiration_time, который в себе содержит unixtime время, когда токен станет недействителен. Порядок работы с токеном выглядит следующим образом:
# После получения токена необходимо сохранить время его истечения.
# Перед каждым запросом нужно проводить проверку, чтобы текущее время было меньше времени истечения жизни токена.
# В противном случае нужно отправить запрос на авторизацию и следовать пунктам №№ 1 и 2.
 
===Параметры===
{| class="wikitable"
|-
| '''body''' ''required''
| Авторизация пользователя
| TEst[http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login Login]
|}
===Ответы===
{| class="wikitable"
| 200
| Ok
| TEst[http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login_Response Login Response]
|}
'''Возвращаемые ресурсом типы MIME'''
*application/json
 
==Определения==
===Login===
Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | password
| Пароль
| string
| qwerty
|-
| style="font-weight:bold;" | direction
| Идентификатор сервера
| string
| food (Запросить у Smart Satu)
|}
 
Пример запроса:
{
"username" : "supplier",
"password" : "qwerty",
"direction" : "food"
}
 
===Login Response===
В ответ на запрос придет массив данных зарегистрированного пользователя с уникальным токином авторизации - "access_token".
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| string
| 132
|-
| style="font-weight:bold;" | email
| Почта
| string
| daulet@smartsatu.kz
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| null
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | first_name
| Имя
| string
| Иван
|-
| style="font-weight:bold;" | last_name
| Фамилия
| string
| Иванов
|-
| style="font-weight:bold;" | middle_name
| Отчество
| string
| Иванович
|-
| style="font-weight:bold;" | access_token
| Уникальный токен для входа
| string
| bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd
|-
| style="font-weight:bold;" | role
| Роль
| string
| 2
|-
| style="font-weight:bold;" | city_id
| Город
| string
| 1
|-
| style="font-weight:bold;" | is_document
| Лицензия
| boolean
| true
|-
| style="font-weight:bold;" | is_replacement
| Доступность обмена
| boolean
| false
|-
| style="font-weight:bold;" | currency
| Валюта
| string
| тг
|-
| style="font-weight:bold;" | price_decimals
| Количество нолей после разделителя
| string
| 2
|-
| style="font-weight:bold;" | price_radix
| Разделитель разрядов
| string
|
|-
| style="font-weight:bold;" | price_decimals_separator
| Разделитель
| string
| .
|-
| style="font-weight:bold;" | price_before_currency
| Порядок показа валюты/цены
| boolean
| true
|-
| style="font-weight:bold;" | price_pattern
| Паттерн цены
| string
| ### ###.## тг
|-
| style="font-weight:bold;" | cashback_enabled
| Доступность кэшбэка
| boolean
| true
|-
| style="font-weight:bold;" | company_id
| Идентификатор компании
| string
| 84
|-
| style="font-weight:bold;" | access_token_expiration_time
| Время действия токена доступа
| string
| 1579535438
|-
| style="font-weight:bold;" | time_zone_offset
| Часовой пояс пользователя
| string
| 21600
|-
| style="font-weight:bold;" | country
| Страна
| string
| kz
|-
| style="font-weight:bold;" | direction
| Стейджинг
| string
| Food
|-
| style="font-weight:bold;" | url_api
| URL
| string
| https://food.smartsatu.com/api
|}
{Пример ответа: "items": [ { "id": 203181132, "store_user_idemail": 656, "store_company_id": 80, daulet@smartsatu.kz"delivery_date": 1537509600, "initial_delivery_datephone": null, "supplier_company_idusername": 84, "supplierCompanyName": "ТОО \"Поставщиk-\"vendoralmaty", "statusfirst_name": 7, "created_atИван": 1528706885, "updated_atlast_name": 1577099908, "with_documents": 1, "sumИванов": 0, "commentsmiddle_name": [ { "idИванович": 75668, "company_idaccess_token": 84, "message": "Товарные позиции заказа были изменены.bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd", "typerole": 42, "order_idstatus": 203181, "created_at": 1537426304, "companyName": "Системное сообщение"1, "is_systemcity_id": 1 } ], "replacement_idis_document": nulltrue, "replacement_statusis_replacement": nullfalse, "alcohol_license": { "numbercurrency": "1234тг", "expire_atprice_decimals": 15908832002, "expire_at_dateprice_radix": "31.05.2020" }, "payment_typeprice_decimals_separator": 0, "order_items": [], "supplier_company_name": "ТОО \"Поставщиk-\"", "store_company": { "route_list": { "start_time": "11:15", "end_time": "23:15" }, "id": 80, "name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"", "min_order_priceprice_before_currency": 0true, "emailprice_pattern": "shop@me### ###.kz## тг", "descriptioncashback_enabled": "Магазин для тестирования\r\n"true, "contactcompany_id": "Телефон: +77775554433, Вн.: 123, Контактное лицо: Гайка"84, "addressaccess_token_expiration_time": "г. Алматы, ул. Стальского д. 31/1"1579535438, "typetime_zone_offset": 1,21600 "tincountry": "012345678912kz", "phonedirection": "+77775554433", "supplier_ruleFood": null, "logourl_api": "httphttps://food.smartsatu.xyzcom/images/no_image_130x130.pngapi", "has_replacement_products": null, "cashback_percent": true, "has_cashback": false, "position": 999, "supplier_store_id": "000000000" } }

Навигация