Использование и подключение API платформы beseller

• Что такое API?
• Что позволяет делать API платформы beseller?
• Информация об оформленных заказах
• Информация о подписчиках
• Информация о зарегистрированных пользователях
• Как протестировать работу с API?
• Как подключиться по API к своему магазину?
• Функции и переменные GraphQL для работы с API платформы beseller
• Как подключиться к API с использованием языка программирования PHP
• Как формировать запросы к API?

Пожалуйста, свяжитесь с менеджерами проекта, для уточнения актуальных возможностей API и получения тестового доступа.

Что позволяет делать API платформы beseller?

Цель создания API платформы beseller — предоставление сторонним приложениям возможности  взаимодействия с сайтами и базами данных интернет-магазинов.

API beseller позволяет создавать собственные приложения,  а также осуществлять синхронизацию данных с системами автоматизации бизнес-процессов: бухгалтерский учет, складской учет, CRM, электронные почтовые рассылки и т.д.

API beseller построен на базе GraphQL и позволяет использовать практически любой язык программирования. API возвращает ответы и данные в формате JSON.

Владельцы интернет-магазинов при помощи сторонних сервисов и собственных приложений имеют возможность обращаться по API к:

Информации об оформленных заказах

Доступные действия (методы) обработки информации о заказах:

1. Выбор информации о заказе по ID
2. Выбор информации о заказах по фильтру
3. Количество заказов по фильтру
4. Создание заказа
5. Удаление заказа
6. Массовое удаление заказов
7. Выбор всех доступных статусов для заказов
8. Обновление статуса заказа
9. Добавление комментария к заказу

Информации о подписчиках

Доступные действия (методы) обработки информации о подписчиках:

1. Добавление подписчика
2. Удаление подписчика
3. Массовое удаление подписчиков
4. Выбор данных о подписчиках по фильтру
5. Количество подписчиков по фильтру

Информации о зарегистрированных пользователях

Доступные действия (методы) обработки информации о подписчиках:

1. Выбор информации о зарегистрированных пользователях по ID
2. Выбор информации обо всех зарегистрированных пользователях
3. Выбор информации обо всех данных указанных пользователем при регистрации:
   • Фамилия, имя, отчество;
   • Контактный адрес электронной почты;
   • Контактный номер телефона;
   • Указанный адрес доставки: индекс, название населенного пункта, название улицы, номер дома, номер корпуса, номер квартиры, этаж;

Обратите внимание! При регистрации, пользователь может не заполнить все указанные выше поля.

 

Планы по развитию API

В ближайшее время, мы планируем открыть интерфейсы для поддержки взаимодействия магазинов со сторонними приложениями и сервисами по работе с:

1. Разделами каталога.
2. Товарами.
3. Корзиной.
4. Скидками.
5. Способами доставки.
6. Способами оплаты.

 

Как протестировать работу с API?

Для тестирования взаимодействия с API платформы beseller создан тестовый магазин demo.beseller.by.

Для доступа к тестовому магазину необходимо указать логин и пароль. Их вы можете получить по запросу у вашего персонального менеджера.

 

Отправить запрос на получение доступа к API beseller

 

Перед тестированием взаимодействия с API мы рекомендуем вам:

1. оформить самостоятельно несколько заказов;
2. подписаться на рассылку;
3. посмотреть как информация об оформленных заказах и подписчиках отображается в панели администрирования магазина.

 

Как подключиться по API к своему магазину?

Для связи приложения с вашим магазином необходимо указать url-адрес доступа к API вида:

http://адрес_вашего_сайта :8082/graphql?token=ваш_персональный_секретный_ключ

Секретный ключ вы можете получить по запросу у вашего персонального менеджера.

 

Отправить запрос на получение ключа для доступа по API к моему магазину

 

Функции и переменные GraphQL для работы с API платформы beseller

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

Файлы содержит описание и примеры:

1. поддерживаемых запросов на выборку данных из базы данных магазина (Root query);
2. поддерживаемых запросов на изменение данных в базе данных магазина (Mutations);
3. поддерживаемых переменных (Arguments);

По мере реализации новых возможностей файл будет обновляться.

Информацию по поддерживаемым запросам и переменным вы также можете получить при помощи GraphiQL Feen, подключившись к тестовому магазину. 

 

Как подключиться к API с использованием языка программирования PHP

Для удобства работы с API платформы beseller вы можете воспользоваться:

1. Классами разработанными нами под PHP.
   1. GraphqlClient — осуществляет прием и передачу данных на сервер;
   2. GraphQlHelper — содержит в себе реализованные query и mutation API;
2. Примерами использования классов для осуществления выборок и изменений в базе данных интернет-магазина.

 

Скачать классы и примеры использования

 

Как формировать запросы к API?

Настройка локального окружения

Для того, чтобы наглядно продемонстрировать отправку запросов к API и получаемые ответы, вы можете воспользоваться локальным окружением.

В качестве локального окружения используется GraphiQL Feen, это расширение для браузера Google Chrome которое позволяет формировать запросы к API.

После установки приложения у вас в браузере возле адресной строки появится иконка приложения.

Откройте приложение GraphiQL Feen и перейти на вкладку «SERVERS», выберите метод отправки POST, после чего укажите url-адрес доступа к API.

Локальное окружение настроено, можно формировать запросы к API. Для этого необходимо открыть вкладку «QUERIES»

Формирование запроса к API beseller при помощи GraphiQL Feen и полученный ответ

Пояснения к скриншоту:

1. Сохраненные запросы
2. Поле для ввода запросов
3. Поле ввода переменных
4. Полученный ответ
5. Кнопка запуска

 

Пример запроса на получение списка оформленных заказов за указанный промежуток времени

query($first: Int, $offset: Int, $filter: OrderFilter) {   filterOrder(first: $first, offset: $offset, filter: $filter) {     id     comment     status {       id       description       name     }     createdAt     updatedAt     total {       suffix       value     }     payment {       name       description       cost {         suffix         value       }     }     delivery {       name       description       cost {         suffix         value       }     }     currencies {       bankCode       course       suffix     }     userData {       name       description       value     }   } } 

 

Указание промежутка времени для выборки данных об оформленных заказах

{ "filter": { "createdAtFrom": "2019-11-16T00:00:01Z", "createdAtTo": "2030-11-23T00:00:01Z"    },    "first": 5 } 

 

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

{   "data": {     "filterOrder": [       {         "id": 1,         "comment": "",         "status": {           "id": 1,           "description": "Новый",           "name": "new"         },         "createdAt": "2020-05-21 16:18:01",         "updatedAt": "2020-05-21 16:18:01",         "total": [           {             "suffix": "руб.",             "value": 1833.4           }         ],         "payment": {           "name": "custom",           "description": "Наличные",           "cost": [             {               "suffix": "руб.",               "value": 0             }           ]         },         "delivery": {           "name": "custom",           "description": "Доставка почтой",           "cost": [             {               "suffix": "руб.",               "value": 53.4             }           ]         },         "currencies": [           {             "bankCode": "BYN",             "course": 10000,             "suffix": "руб."           }         ],         "userData": [           {             "name": "fio",             "description": "ФИО",             "value": "324234"           },           {             "name": "phone",             "description": "Телефон",             "value": "4324342"           },           {             "name": "registration",             "description": "Адрес",             "value": "342343"           },           {             "name": "comment",             "description": "Комментарий",             "value": "343434324"           }         ]       }     ]   } }