Giftery Rewards API

Методы административного API

Публичное API витрин Giftery. Для получения токена воспользуйтесь специальным интерфейсом в административном интерфейсе вашей витрины.

Базовый путь: /{code}/api/admin.

Swagger документация ↗

Раздел	Метод	HTTP	Описание
Пользователи	/account/{aid}	GET	Просмотр информации о пользователе
Пользователи	/account/{aid}	DELETE	Удаление пользователя
Пользователи	/account/{aid}	PATCH	Изменение данных пользователя
Пользователи	/account/{aid}/activate	PATCH	Активация пользователя
Пользователи	/account/{aid}/balance	GET	Просмотр баланса пользователя
Пользователи	/account/{aid}/deactivate	PATCH	Деактивация пользователя
Заказы	/account/{aid}/order/{oid}	GET	Просмотр информации о заказе пользователя
Заказы	/account/{aid}/orders	GET	Получение заказов пользователя
Заказы	/account/{aid}/orders	POST	Создание заказа пользователя
Пользователи	/account/{aid}/password	PATCH	Смена пароля пользователя
Задания	/account/{aid}/task/{tid}/contract/link	GET	Ссылка на подписание акта в Окидоки
Задания	/account/{aid}/tasks	GET	Список заданий пользователя витрины
Налоги	/account/{aid}/tax/inn/simple	GET	Получение ИНН пользователя
Налоги	/account/{aid}/tax/passport	GET	Получение результатов автоматического распознавания документов
Налоги	/account/{aid}/tax/passport	POST	Отправка документов подтверждающих личность
Налоги	/account/{aid}/tax/upload	POST	Отправка подписанного акта
Налоги	/account/{aid}/tax/verified	POST	Завершение автоматического подтверждения личности
Налоги	/account/{aid}/tax/verify	POST	Отправка документов подтверждающих личность
Пользователи	/account/{aid}/token	POST	Получение токена пользователя (авторизация)
Пользователи	/accounts	GET	Список пользователей
Пользователи	/accounts	POST	Регистрация пользователя
Каталог	/catalog	GET	Получение каталога сертификатов
Задания	/task/{tid}	GET	Информация о задании
Задания	/task/{tid}/approve	PATCH	Утвердить задание
Задания	/task/{tid}/decline	PATCH	Отклонить задание
Задания	/task/{tid}/review	PATCH	Начать рассмотрение задания
Задания	/tasks	GET	Список заданий витрины
Транзакции	/transactions	POST	Изменение баланса пользователя по номеру телефона или почты
Транзакции	/transactions/upload	POST	Изменение баланса пользователей через загрузку файла
Транзакции	/transactions/{aid}	POST	Изменение баланса пользователя по идентификатору

Методы клиентского API

Публичное API витрин Giftery. Для получения токена воспользуйтесь методами авторизации.

Базовый путь: /{code}/api/store.

Swagger документация ↗

Раздел	Метод	HTTP	Описание
Пользователь	/balance	GET	Получение баланса авторизованного пользователя
Каталог	/catalog	GET	Получение каталога сертификатов
Авторизация	/code	POST	Запрос кода авторизации в СМС
Авторизация	/login/code	POST	Авторизация по коду из СМС
Авторизация	/login/password	POST	Авторизация по логину-паролю
Авторизация	/logout	DELETE	Выход из системы
Заказы	/orders	GET	Получение списка заказов
Заказы	/orders	POST	Создание заказа
Авторизация	/refresh-token	PUT	Обновление токена авторизации
Пользователь	/user	GET	Получение профиля авторизованного пользователя

Вебхуки

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

Swagger документация ↗

Метод	HTTP	Описание
/balance_transaction	POST	Изменение баланса пользователя (зачисление, списание, возврат)
/order_fulfilled	POST	Исполнение заказа
/passport_recognized	POST	Завершено распознавание паспорта