AdSimple API (0.1.1)

Download OpenAPI specification:Download

Авторизация

Получение токена доступа для работы с AdSimple API

Запрос доступа для работы с API

В случае успеха произойдет перенаправление на страницу, указанную в redirect_uri.

В адрес страницы будет добавлено значение параметра code, необходимое для дальнейшей процедуры получения токена доступа.

query Parameters

client_id required	string Идентификатор приложения
redirect_uri required	string Example: redirect_uri=http://example.com/auth/adsimple Адрес страницы, на которую будет перенаправлен пользователь. Домен адреса должен совпадать с доменом, указанным при регистрации приложения.
response_type required	string Value: "code"
scope required	string Example: scope=user_info user_accounts Перечисление прав, для которых будет выдан доступ, разделенные пробелом. `user_info` - Получение информация о пользователе `user_wallets` - Информация о платежных профилях и балансах кошельков `user_accounts` - Получение списка аккаунтов и детальной информации по ним, пополнение баланса и список переводов на баланс аккаунта. Создание аккаунтов ВКонтакте и Яндекс.Директ. Получение токенов для работы с API ВК Реклама и MyTarget

Responses

Получение токена

Получение или обновление ранее выданного токена доступа.

При первом получении токена в параметр grant_type необходимо передать значение authorization_code, а так же передать параметр code, соответствующий полученному аргументу code из предыдущего этапа авторизации.

При обновлении токена в параметр grant_type необходимо передать значение refresh_token, а так же передать параметр refresh_token, полученный при последней авторизации.

query Parameters

client_id required	string Идентификатор приложения
client_secret required	string Секретный ключ вашего приложения
grant_type required	string Enum: "authorization_code" "refresh_token"
redirect_uri required	string Example: redirect_uri=http://example.com/auth/adsimple Адрес страницы, на которую будет перенаправлен пользователь. Домен адреса должен совпадать с доменом, указанным при регистрации приложения.
code	string Код авторизации, полученный на предыдущем шаге
refresh_token	string Токен для обновления доступа, полученный при последней авторизации

Responses

Response samples

200
400

Content type

application/json

{"access_token": "string",
"refresh_token": "string",
"expires_in": 3600,
"scope": "string"
}

Пользователи

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

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

Информация о пользователе, от чьего имени был получен токен доступа

Authorizations:

oauth2

query Parameters

access_token

required

string

Токен доступа для работы с AdSimple API

Responses

Response samples

200
401
403

Content type

application/json

{"status": "success",
"data": {"id": 1
}
}

Аккаунты

Управление аккаунтами рекламных сетей

Список аккаунтов

Authorizations:

oauth2

query Parameters

access_token required	string Токен доступа для работы с AdSimple API
status	Array of strings Items Enum: "new" "pending" "verified" "declined" "block" "deleted" "error"
limit	integer Example: limit=50 Максимальное количество возвращаемых результатов
offset	integer Example: offset=150 Смещение списка возвращаемых результатов

Responses

Response samples

200
401
403

Content type

application/json

{"status": "success",
"data": [{"id": 1,
"status": "new",
"network_account_id": 1,
"user": 1,
"type": "{account_type}",
"login": "adsimple-u1-1",
"balance": 1
}
],
"pagination": {"offset": 0,
"limit": 50,
"total": 10
}
}

Создание аккаунта ВКонтакте

Authorizations:

oauth2

query Parameters

access_token

required

string

Токен доступа для работы с AdSimple API

Request Body schema: application/json

vk_user_id required	number Идентификатор пользователя ВКонтакте
required	object

Responses

Request samples

Payload

Content type

application/json

{"vk_user_id": 12345678,
"advertiser_info": {"type": "legal",
"tax_number": "560504123456",
"phone": "+78005553535",
"name": "Петров Петя Петрович",
"contract": {"number": "string",
"date": "2019-08-24",
"type": "contract",
"amount": 0,
"vat_included": true,
"subject_type": "representation",
"action_type": "commercial"
},
"counterparty": {"type": "legal",
"name": "Петров Петя Петрович",
"tax_number": "560504123456",
"phone": "+78005553535"
}
}
}

Response samples

200
401
403

Content type

application/json

{"status": "success",
"data": {"id": 1,
"status": "new",
"network_account_id": 1,
"user": 1,
"type": "{account_type}",
"login": "adsimple-u1-1",
"balance": 1
}
}

Создание аккаунта Яндекс.Директ

Authorizations:

oauth2

query Parameters

access_token

required

string

Токен доступа для работы с AdSimple API

Request Body schema: application/json

firstname required	string Имя пользователя
lastname required	string Фамилия пользователя
email required	string <email> Email пользователя
required	object

Responses

Request samples

Payload

Content type

application/json

{"firstname": "string",
"lastname": "string",
"email": "user@example.com",
"advertiser_info": {"type": "legal",
"tax_number": "560504123456",
"phone": "+78005553535",
"name": "Петров Петя Петрович",
"contract": {"number": "string",
"date": "2019-08-24",
"type": "contract",
"amount": 0,
"vat_included": true,
"subject_type": "representation",
"action_type": "commercial"
},
"counterparty": {"type": "legal",
"name": "Петров Петя Петрович",
"tax_number": "560504123456",
"phone": "+78005553535"
}
}
}

Response samples

200
401
403

Content type

application/json

{"status": "success",
"data": {"id": 1,
"status": "new",
"network_account_id": 1,
"user": 1,
"type": "{account_type}",
"login": "adsimple-u1-1",
"balance": 1
}
}

Токен аккаунта ВК Рекламы

Authorizations:

oauth2

query Parameters

access_token

required

string

Токен доступа для работы с AdSimple API

Responses

Response samples

200
401
403
404

Content type

application/json

{"status": "success",
"data": {"token": "Z5IVgOSMz5GNaNGQVCfQzsxOhNvD8wNbPC4TKKkmVbgsejXoa2Nf...",
"expires_at": "2019-08-24T14:15:22Z"
}
}

Кошельки

Информация о кошельках и их балансах

Список кошельков

Authorizations:

oauth2

query Parameters

access_token

required

string

Токен доступа для работы с AdSimple API

Responses

Response samples

200
401
403

Content type

application/json

{"status": "success",
"data": [{"id": 1,
"name": "string",
"currency": "RUB",
"balance": 1,
"profile": 1
}
]
}

Переводы

Управление переводами с баланса кошельков на аккаунты в рекламных сетях

История переводов

Authorizations:

oauth2

query Parameters

access_token required	string Токен доступа для работы с AdSimple API
date_from	string Example: date_from=2021-05-01 Дата начала периода в формате YYYY-MM-DD
date_to	string Example: date_to=2021-05-14 Дата окончания периода в формате YYYY-MM-DD
statuses	Array of strings Items Enum: "pending" "paused" "success" "error" "cancelled" "declined" Example: statuses=pending&statuses=error Статусы переводов
accounts	Array of integers Example: accounts=12&accounts=957&accounts=62 Идентификаторы аккаунтов
direction	Array of strings Items Enum: "in" "out" Example: direction=in&direction=out Направления переводов
limit	integer Example: limit=50 Максимальное количество возвращаемых результатов
offset	integer Example: offset=150 Смещение списка возвращаемых результатов

Responses

Response samples

200
401
403

Content type

application/json

{"status": "success",
"data": [{"id": 1,
"amount": 1200.5,
"currency": "RUB",
"wallet": 1,
"status": "pending",
"created_at": "2022-03-01T15:00:00+03:00",
"updated_at": "2022-03-01T15:00:00+03:00",
"network": "yd",
"account": 1,
"direction": "in"
}
],
"pagination": {"offset": 0,
"limit": 50,
"total": 10
}
}

Перевод на баланс аккаунта

Authorizations:

oauth2

query Parameters

access_token

required

string

Токен доступа для работы с AdSimple API

Request Body schema: application/json

account	integer Идентификатор аккаунта
wallet	integer Идентификатор кошелька
amount	integer Сумма перевода

Responses

Request samples

Payload

Content type

application/json

{"account": 1,
"wallet": 1,
"amount": 1200
}

Response samples

200
400
401
403

Content type

application/json

{"status": "success",
"data": {"id": 1,
"amount": 1200.5,
"currency": "RUB",
"wallet": 1,
"status": "pending",
"created_at": "2022-03-01T15:00:00+03:00",
"updated_at": "2022-03-01T15:00:00+03:00",
"network": "yd",
"account": 1,
"direction": "in"
}
}

Информация о переводе

Authorizations:

oauth2

path Parameters

id

required

integer

Example: 1

query Parameters

access_token

required

string

Токен доступа для работы с AdSimple API

Responses

Response samples

200

Content type

application/json

{"status": "string",
"data": {"id": 1,
"amount": 1200.5,
"currency": "RUB",
"wallet": 1,
"status": "pending",
"created_at": "2022-03-01T15:00:00+03:00",
"updated_at": "2022-03-01T15:00:00+03:00",
"network": "yd",
"account": 1,
"direction": "in"
}
}

Платежные профили

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

Authorizations:

oauth2

path Parameters

network_type

required

string

Enum: "vk" "yd"

Тип рекламной сети

query Parameters

access_token

required

string

Токен доступа для работы с AdSimple API

Responses

Response samples

200

Content type

application/json

{"status": "success",
"data": [{"id": 1,
"title": "Иван Иванов"
}
]
}