API Authorization: различия между версиями

Материал из SmartSatu Knowledge Base
Перейти к навигации Перейти к поиску
Строка 4: Строка 4:
 
Данный документа описывает методы для работы поставщика/дистрибьютора с системой Smart Satu
 
Данный документа описывает методы для работы поставщика/дистрибьютора с системой Smart Satu
  
Версия
+
'''Версия'''
 +
 
 
''Version'': 1.0.0
 
''Version'': 1.0.0
  
Контактная информация
+
'''Контактная информация'''
  
 
''Contact'': [[info@smartsatu.com]]
 
''Contact'': [[info@smartsatu.com]]
  
URI схема
+
'''URI схема'''
 +
 
 
''Host : //smartsatu.com/api/user/  Schemes : HTTPS''
 
''Host : //smartsatu.com/api/user/  Schemes : HTTPS''
  
 
==Методы==
 
==Методы==
Авторизация пользователя.
+
'''Авторизация пользователя'''
  
 
POST /login 
 
POST /login 
Строка 22: Строка 24:
 
Метод для авторизации пользователя в системе Smart Satu
 
Метод для авторизации пользователя в системе Smart Satu
 
===Параметры===
 
===Параметры===
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-

Версия 00:34, 13 января 2020

API Авторизации

Обзор

Данный документа описывает методы для работы поставщика/дистрибьютора с системой Smart Satu

Версия

Version: 1.0.0

Контактная информация

Contactinfo@smartsatu.com

URI схема

Host : //smartsatu.com/api/user/  Schemes : HTTPS

Методы

Авторизация пользователя

POST /login 

Описание

Метод для авторизации пользователя в системе Smart Satu

Параметры

Type Name Description Schema
Body body required Авторизация пользователя Login

Ответы

HTTP Code Description Schema
200 Ok Login Response

Принимаемые ресурсом типы MIME

  • application/json

Возвращаемые ресурсом типы MIME

  • application/json

Определения

Login

Name Description Schema Example
login Логин string supplier
password Пароль string qwerty

Пример запроса:

{
 "username" : "supplier",
 "password" : "qwerty"
}

Login Response

Name Description Schema Example
id Уникальный идентификатор string 132
email Почта string daulet@smartsatu.kz
phone Номер телефона string null
username Логин string supplier
first_name Имя string Иван
last_name Фамилия string Иванов
middle_name Отчество string Иванович
access_token Уникальный токен для входа string bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd
role Роль string 2
city_id Город string 1
is_document Лицензия boolean true
is_replacement Доступность обмена boolean false
currency Валюта string тг
price_decimals Количество нолей после разделителя string 0
price_radix Разделитель разрядов string
price_decimals_separator Разделитель string .
price_before_currency Порядок показа валюты/цены boolean true
price_pattern Паттерн цены string ### ### тг
cashback_enabled Доступность кэшбэка boolean true
company_id Идентификатор компании string 84
country Страна string kz
direction Стейджинг string Food
url_api URL string https://food.smartsatu.xyz/api

Пример ответа:

{
"id": 132,
"email": "daulet@smartsatu.kz",
"phone": null,
"username": "vendoralmaty",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"access_token": "bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd",
"role": 2,
"status": 1,
"city_id": 1,
"is_document": true,
"is_replacement": false,
"currency": "тг",
"price_decimals": 0,
"price_radix": " ",
"price_decimals_separator": ".",
"price_before_currency": true,
"price_pattern": "### ### тг",
"cashback_enabled": true,
"company_id": 84,
"country": "kz",
"direction": "Food",
"url_api": "https://food.smartsatu.xyz/api"
}