Изменения

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

API Authorization

3474 байта добавлено, 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
| Количество нолей после разделителя
| string
| 02
|-
| style="font-weight:bold;" | price_radix
| Паттерн цены
| string
| ### ###.## тг
|-
| style="font-weight:bold;" | cashback_enabled
| 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
| URL
| string
| https://food.smartsatu.xyzcom/api
|}
Пример ответа:
{
"id": 132,
"is_replacement": false,
"currency": "тг",
"price_decimals": 02,
"price_radix": " ",
"price_decimals_separator": ".",
"price_before_currency": true,
"price_pattern": "### ### тг.## тг",
"cashback_enabled": true,
"company_id": 84,
"access_token_expiration_time": 1579535438,
"time_zone_offset": 21600
"country": "kz",
"direction": "Food",
"url_api": "https://food.smartsatu.xyzcom/api"
}

Навигация