URL

Ниже приведена информация о endpoint и методе http, используемом для поиска ссылки:

HTTP Metod URL
GET /tokenlink/v1/products

Параметры запроса

Ожидаемые URL параметры, которые будут отправлены в запросах на поиск ссылки, перечислены в таблице и подзаголовках ниже.

Название параметра Тип Обязательный Объяснение
name string Нет Название, присвоенное ссылке
status Status Нет Статус ссылки
token string Нет Уникальный токен ссылки
page number Нет Может использоваться для реализации нумерации страниц, defolt равно 0.
size number Нет Может использоваться для реализации нумерации страниц, defolt равно 10.

Параметры возврата

Параметры, возвращаемые в результате процесса поиска ссылки, подчиняются правилам Форматы возврата на главной странице API документации. При отсутствии систематичной или структурной ошибки, нижние параметры возвращающегося объекта в data параметрах следующие:

Название параметра Тип Объяснение
page number Номер страницы
size number Общее количество результатов
totalSize number Общее количество результатов
items Link[] См. информацию о ссылке Параметры возврата ссылки

Параметры возврата ссылки

Название параметра Тип Всегда доступен Объяснение
id long Да ID ссылки
status Status Да Значение, показывающее статус ссылки. Для активных ссылок отображается как ACTIVE, для пассивных PASSIVE. Ссылка, созданныя после операции создания ссылки, всегда ACTIVE.
name string Да Название, присвоенное ссылке
description string Нет Подробное описание ссылки
price decimal Нет Цена ссылки
stock number Нет Количество запасов ссылки.
soldCount number Да Он показывает, сколько раз была произведена оплата по ссылке.
enabledInstallments string Нет Вы можете использовать это поле, если хотите получать только указанные вами платежи в рассрочку. Пример: 1,2,3,6 Вы можете использовать это поле, если хотите получать только указанные вами платежи в рассрочку. Пример: 1,2,3,6
expireDate date Нет Срок действия ссылки.
token string Да Это 4-значный уникальный ключ, присвоенный ссылке.
url string Да URL информация ссылки. Вы можете поделиться этой ссылкой и получать деньги от своих пользователей.
qrCodeUrl string Да Ссылка представляет собой ссылку с QR-кодом. Вы можете получить доступ к ссылке для оплаты, отсканировав QR-код.

Примеры кодов

Вы можете просмотреть примеры кодов в Odero API client с открытым исходным кодом: