Выдать бонусы
Важно
Домен toloka.yandex.com
работает в режиме deprecated. Рекомендуем переключиться на домен toloka.dev
для запросов API.
Выдает бонусы исполнителям.
Сумма бонуса может составлять от 0,005 $ до 100 $ одному исполнителю единовременно.
Ограничение
Вы можете отправить не более 10 000 таких запросов в день.
В одном запросе нельзя передавать одному толокеру несколько бонусов с одинаковой ценой, названием и сообщением. Будет возвращен ответ со статусом 409.
{
"user_id": {
"code": "ENTITY_CONFLICT",
"message": "It is not allowed to apply multiple bonuses with the same amount, title, message and comment to same user in single operation"
}
}
Запрос
POST https://toloka.dev/api/v1/user-bonuses
Authorization: OAuth <OAuth token>
Content-Type: application/JSON
POST https://sandbox.toloka.dev/api/v1/user-bonuses
Authorization: OAuth <OAuth token>
Content-Type: application/JSON
Заголовки
Заголовок | Описание |
---|---|
Authorization | Токен для авторизации аккаунта. В качестве префикса добавьте OAuth. |
Content-Type | Указывает формат данных в передаваемом теле запроса. |
Query-параметры
Указываются в ссылке после знака вопроса, перечисляются через &
.
Параметр |
Описание |
async_mode |
boolean Способ обработки запроса:
По умолчанию значение |
assignment_id |
string Идентификатор ответа исполнителя на задание, за которое выплачивается бонус. |
skip_invalid_items |
boolean Параметры валидации JSON-объектов:
По умолчанию значение |
operation_id |
string Идентификатор операции. Можно использовать при любом способе обработки запроса. |
Тело запроса
{
"user_id": "21c4f092ebad180cf56b9babe0ef9f19",
"amount": 1.5,
"assignment_id": "6946cefa-32af-4f62-b530-8d2c71fa2966",
"private_comment": "Good job!",
"public_title": {
"EN": "Completed tasks"
},
"public_message": {
"EN": "10 tasks successfully completed"
},
"without_message": false
}
Параметр |
Описание |
user_id |
string Обязательный параметр. Идентификатор исполнителя. |
amount |
float Обязательный параметр. Сумма бонуса в долларах. |
assignment_id |
string Идентификатор ответа исполнителя на задание, за которое выплачивается бонус. |
private_comment |
string Комментарий, доступный только заказчику. |
public_title |
object Заголовок сообщения для исполнителя. Может быть на нескольких языках (сообщение придет на языке исполнителя). Формат: |
public_message |
object Текст сообщения для исполнителя. Может быть текст на нескольких языках (сообщение придет на языке исполнителя). Формат: |
without_message |
boolean Позволяет не отправлять исполнителю сообщение о бонусе. По умолчанию Для того чтобы выдать бонус без сообщения, нужно указать |
Ответ
Формат ответа зависит от значения query-параметра async_mode
.
{
"items": {
"0": {details of a reward #0},
"2": {details of a reward #2},
"<N>": {details of a reward #N}
},
"validation_errors": {
"1": {validation errors for a reward #1},
"3": {validation errors for a reward #3},
"<N>": {validation errors for a reward #N}
}
}
Параметр |
Описание |
items |
string Объект со сведениями о выданных бонусах. |
validation_errors |
string Объект с ошибками валидации. Возвращается, если в запросе используется параметр |
{
"id": "26e130ad3652443a3dc5094791e48ef9",
"type": "USER_BONUS.BATCH_CREATE",
"status": "SUCCESS",
"submitted": "2020-12-13T23:32:01",
"started": "2020-12-13T23:33:00",
"finished": "2020-12-13T23:34:12",
"parameters": {
"skip_invalid_items": true
},
"details": {
"total_count": 2,
"valid_count": 2,
"not_valid_count": 0,
"success_count": 2,
"failed_count": 0
}
}
Параметр |
Описание |
id |
string Идентификатор операции. |
type |
string Тип операции |
status |
string Статус операции:
|
submitted |
string Дата и время отправки запроса по UTC в формате ISO 8601: |
started |
string Дата и время начала операции по UTC в формате ISO 8601: |
finished |
string Дата и время окончания операции по UTC в формате ISO 8601: |
parameters |
object Параметры операции в запросе. |
skip_invalid_items |
boolean Параметры валидации JSON-объектов:
По умолчанию значение |
details |
object Сведения о выполнении операции. |
details.total_count |
integer Количество бонусов в запросе. |
details.valid_count |
integer Количество JSON-объектов со сведениями о бонусе, которые прошли валидацию. |
details.not_valid_count |
integer Количество JSON-объектов со сведениями о бонусе, которые не прошли валидацию. |
details.success_count |
integer Количество выданных бонусов. |
details.failed_count |
integer Количество бонусов, которые не были выданы. |