Ниже приведена информация о endpoint и методе http, используемом для обновления ссылки:
| HTTP Metod | URL | URL Parametrləri |
|---|---|---|
PUT |
/tokenlink/v1/products/:id |
id: ID значение ссылки |
Ожидаемые параметры, которые будут отправлены в запросах на обновление существующей ссылки, перечислены под таблицей и подзаголовками ниже. Запрос связанный с обновлением обновляет каждую ячейку в запросе на обновление, аналогично другим запросам на обновление. По этой причине цены, которые не требуют обновления, следует заменить текущими ценами ссылки.
| Название параметра | Тип | Обязательный | Объяснение |
|---|---|---|---|
name |
string |
Да | Название, присвоенное ссылке |
status |
string |
Да | Значение, показывающее статус ссылки. |
description |
string |
Нет | Подробное объяснение ссылки. Вы можете использовать его для информирования пользователя на странице оплаты. |
price |
decimal |
Нет | Стоимость платежа, которая можно получить по ссылке. Если продукт не отправлен, пользователь может ввести цену в форме оплаты. |
stock |
number |
Нет | Если вы продаете продукт, который есть в наличии, вы можете указать количество товара на складе. |
expireDate |
date |
Нет | Если вы хотите сделать ссылку недействительной после определенной даты, вы можете отправить срок действия ссылки. |
enabledInstallments |
string |
Нет | Вы можете использовать это поле, если хотите получать только указанные вами платежи в рассрочку. Пример: 1,2,3,6 |
Параметры, возвращаемые в результате обновления ссылки, подчиняются правилам Форматы возврата на главной странице API документации. При отсутствии систематичной или структурной ошибки, нижние параметры возвращающегося объекта в data параметрах следующие:
| Название параметра | Тип | Всегда доступен | Объяснение |
|---|---|---|---|
id |
long | Да | ID значение ссылки |
status |
Status | Да | Значение, показывающее статус ссылки. Для активных ссылок отображается как ACTIVE, для пассивных PASSIVE. Ссылка, созданныя после операции создания ссылки, всегда ACTIVE. |
Вы можете просмотреть примеры кодов в Odero API client с открытым исходным кодом: