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

Материал из SmartSatu Knowledge Base
Перейти к навигации Перейти к поиску
(Created page with "==Обзор== Данный документа описывает методы для работы поставщика/дистрибьютора с системой Smart Sa...")
 
 
(не показано 12 промежуточных версий этого же участника)
Строка 1: Строка 1:
 
==Обзор==
 
==Обзор==
−
Данный документа описывает методы для работы поставщика/дистрибьютора с системой Smart Satu
+
Данный документа описывает методы для работы поставщика/дистрибьютора по получению списка Торговых точек из системы Smart Satu.
  
 
'''Версия'''
 
'''Версия'''
Строка 12: Строка 12:
 
'''URI схема'''
 
'''URI схема'''
  
−
''Host : //smartsatu.com/api/counterparties/  Schemes : HTTPS''
+
''Host : //food.smartsatu.com/api/counterparties/  Schemes : HTTPS''
−
 
 
  
 
==Методы==
 
==Методы==
Строка 19: Строка 18:
  
 
GET /counterparties 
 
GET /counterparties 
−
===Описание===
+
==Описание==
−
Метод получение списка торговых точек
+
Для получения списка из 20-ти первых торговых точек из системы Smart Satu, отправьте GET-запрос по следующему URL:
−
===Безопасность===
+
https://food.smartsatu.com/api/counterparties
 +
 
 +
Для получения последующих записей используйте параметр "page", который указывает номер страницы. Пример:
 +
https://food.smartsatu.com/api/counterparties?page=2
 +
 
 +
Вы можете отфильтровать список контрагентов, используя параметр "updated_from". Этот параметр возвращает записи, созданные или измененные начиная с указанного времени в формате Y-m-d\TH:i:s. Пример:
 +
https://food.smartsatu.com/api/counterparties?updated_from=2024-11-24T11:05:04
 +
 
 +
==Безопасность==
 +
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему.
 
{| class="wikitable"
 
{| class="wikitable"
 
! style="font-weight:bold;" | Type
 
! style="font-weight:bold;" | Type
Строка 40: Строка 48:
 
===Параметры===
 
===Параметры===
 
====Ответы====
 
====Ответы====
 +
{| class="wikitable"
 +
! style="font-weight:bold;" | HTTP Code
 +
! style="font-weight:bold;" | Description
 +
! style="font-weight:bold;" | Schema
 +
|-
 +
| style="font-weight:bold;" | 200
 +
| Ok
 +
| [http://docs.smartsatu.com/wiki/API_Counterparties#Response_Counterparties Response Counterparties]
 +
|-
 +
| style="font-weight:bold;" | 401
 +
| Unauthorized
 +
| [http://docs.smartsatu.com/wiki/API_Counterparties#401 401]
 +
|}
  
 +
'''Принимаемые ресурсом типы MIME'''
 +
*application/json
 +
'''Возвращаемые ресурсом типы MIME'''
 +
*application/json
  
 
==Определения==
 
==Определения==
 
===Response Counterparties===
 
===Response Counterparties===
 +
'''200'''
 +
 +
'''Items'''
 +
{| 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
 +
| Уникальный идентификатор
 +
| integer
 +
| 80
 +
|-
 +
| style="font-weight:bold;" | name
 +
| Название торговой точки
 +
| string
 +
| ИП "Чип и Дейл" | маг. "Рокфор"
 +
|-
 +
| style="font-weight:bold;" | address
 +
| Адрес торговой точки
 +
| string
 +
| Алматы, Байзакова, 125/185
 +
|-
 +
| style="font-weight:bold;" | conacts
 +
| Массив
 +
| <contacts> array
 +
|
 +
|-
 +
| style="font-weight:bold;" | type
 +
| Тип торговой точки
 +
| string
 +
| store
 +
|-
 +
| style="font-weight:bold;" | tin
 +
| ИНН торговой точки
 +
| string
 +
| AZ0123456789
 +
|-
 +
| style="font-weight:bold;" | ucs
 +
| Уникальный идентификатор ТТ у поставщика (пр. GUID)
 +
| string
 +
| AZ0123456789
 +
|}
 +
'''Contacts'''
 +
{| 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;" | phone
 +
| Номер телефона
 +
| string
 +
| 78000000001
 +
|-
 +
| style="font-weight:bold;" | person
 +
| Персона (Контактное лицо)
 +
| string
 +
| Гайка
 +
|-
 +
| style="font-weight:bold;" | ext
 +
| Дополнительный номер
 +
| string
 +
| 123
 +
|-
 +
| style="font-weight:bold;" | type
 +
| Тип контакта
 +
| string
 +
|
 +
|}
 +
Пример ответа:
 +
{
 +
  "Items": [
 +
    {
 +
      "id": 80,
 +
      "name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
 +
      "address": "Алматы, Байзакова, 125/185",
 +
      "contacts": [
 +
        {
 +
          "phone": "78000000001",
 +
          "person": "Гайка",
 +
          "ext": "123",
 +
          "type": " "
 +
        }
 +
      ],
 +
      "type": "store",
 +
      "tin": "AZ0123456789"
 +
      "ucs": "AZ0123456789"
 +
    }
 +
  ]
 +
}
 +
 
===401===
 
===401===
 +
{| 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;" | name
 +
| Название торговой точки
 +
| string
 +
| Unauthorized
 +
|-
 +
| style="font-weight:bold;" | message
 +
| Сообщение
 +
| string
 +
| Your request was made with invalid credentials
 +
|-
 +
| style="font-weight:bold;" | code
 +
| Код
 +
| integer
 +
| 0
 +
|-
 +
| style="font-weight:bold;" | status
 +
| Статус
 +
| integer
 +
| 401
 +
|-
 +
| style="font-weight:bold;" | type
 +
| Тип
 +
| string
 +
|
 +
|}
 +
{
 +
  "name": "Unauthorized",
 +
  "message": "Your request was made with invalid credentials.",
 +
  "code": 0,
 +
  "status": 401,
 +
  "type": "yii\\web\\UnauthorizedHttpException"
 +
}

Текущая версия на 06:50, 25 ноября 2024

Обзор

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

Версия

Version: 1.0.0

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

Contact: info@smartsatu.com

URI схема

Host : //food.smartsatu.com/api/counterparties/  Schemes : HTTPS

Методы

Получение списка торговых точек

GET /counterparties 

Описание

Для получения списка из 20-ти первых торговых точек из системы Smart Satu, отправьте GET-запрос по следующему URL: https://food.smartsatu.com/api/counterparties

Для получения последующих записей используйте параметр "page", который указывает номер страницы. Пример: https://food.smartsatu.com/api/counterparties?page=2

Вы можете отфильтровать список контрагентов, используя параметр "updated_from". Этот параметр возвращает записи, созданные или измененные начиная с указанного времени в формате Y-m-d\TH:i:s. Пример: https://food.smartsatu.com/api/counterparties?updated_from=2024-11-24T11:05:04

Безопасность

В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему.

Type In Name Description
Authorization header required Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
country header required Параметр страны должен использоваться в каждом запросе в системе.

Параметры

Ответы

HTTP Code Description Schema
200 Ok Response Counterparties
401 Unauthorized 401

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

  • application/json

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

  • application/json

Определения

Response Counterparties

200

Items

Name Description Schema Example
id Уникальный идентификатор integer 80
name Название торговой точки string маг. "Рокфор"
address Адрес торговой точки string Алматы, Байзакова, 125/185
conacts Массив <contacts> array
type Тип торговой точки string store
tin ИНН торговой точки string AZ0123456789
ucs Уникальный идентификатор ТТ у поставщика (пр. GUID) string AZ0123456789

Contacts

Name Description Schema Example
phone Номер телефона string 78000000001
person Персона (Контактное лицо) string Гайка
ext Дополнительный номер string 123
type Тип контакта string

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

{
  "Items": [
    {
      "id": 80,
      "name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
      "address": "Алматы, Байзакова, 125/185",
      "contacts": [
        {
          "phone": "78000000001",
          "person": "Гайка",
          "ext": "123",
          "type": " "
        }
      ],
      "type": "store",
      "tin": "AZ0123456789"
      "ucs": "AZ0123456789"
    }
  ]
}

401

Name Description Schema Example
name Название торговой точки string Unauthorized
message Сообщение string Your request was made with invalid credentials
code Код integer 0
status Статус integer 401
type Тип string 
{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "code": 0,
  "status": 401,
  "type": "yii\\web\\UnauthorizedHttpException"
}
Источник — https://docs.smartsatu.com/wiki/index.php?title=API_Counterparties&oldid=1692