API Документация (API DOCS)
Главное
Описание
❗ API представляет собой 1 универсальный запрос, который легко и просто интегрировать в свои скрипты и приложения.
API Основной URL Запросов
Базовый URL для запросов это https://api.definova.club.
Заголовки Запросов передавать не нужно.
Параметры Запросов
- sku – ID вашего приложения внутри маркетплейса. Например, sku-123
- apikey – API ключ пользователя для съёма средств в рамках ваших приложений. Например, Xs7orN1RnbI4Hn1mB3
- payment_key – ключ полезного действия, которое задается при добавлении и редактировании приложений в личном кабинете. Например, key_like
💡 В параметре payment_key должны использовать только английские буквы, цифры и нижнее подчеркивание.
Параметр sku появится после успешного прохождения модерации вашего приложения и размещения в каталоге маркетплейса Definova. Вы увидите его сразу после размещения, независимо от статуса в разделе:
Параметр apikey берется в личном кабинете и отображается в панели управления на любой из страниц профиля: https://definova.club/my-account
💡 Api Ключ указывает пользователь, когда пользуется вашим приложением. Вы должно предусмотреть переменную или ресурс в настройках для него.
Параметры payment_key указываются при добавлении приложения и назначении цены за полезные действия: https://definova.club/my-account/productedit/add
💡 Доступно только для разработчиков.
Тип Содержимого
Тело запроса отправляется с типом: urlencode или application/x-www-form-urlencoded
Типы Приложений
При загрузке приложений вы можете указывать тип. Есть 2 типа приложений:
- Оплата за полезные действия
- Помесячная Подписка
💡 Оплата за полезные действия: этот тип приложения списывает средства с баланса пользователя за выполненное действие внутри вашего приложения. Например, вы создали приложение, которое регистрирует аккаунты Google. После каждой успешной регистрации вы интегрируете модуль или используете запрос для снятия баланса пользователя. Если действий в вашем приложении несколько, то необходимо после каждого вызывать модуль или запрос с передачей параметра полезного действия.
💡 Помесячная Подписка: этот тип приложения списывает средства с баланса раз в месяц при условии, что пользователь пользуется приложением. В своем приложении вы можете вызывать 1 раз модуль комиссионных раз в час или в день, в зависимости от специфики приложения и его автономной работы и сервер маркетплейса будет понимать когда осуществить списание.
Особенности
Для каждого полезного действия, задаваемого вами внутри приложений при интеграции необходимо слать разные ключи полезных действий.
Перед запуском скрипта в функцию OnApplicationStart необходимо поместить проверку авторизации.
Параметры Запроса
Параметры, помеченные * необходимо передавать в любом случае, независимо от типа приложения (оплата за полезные действия или помесячная подписка).
Примеры Запросов
BAS Модуль
Можно использовать в любых версиях BAS начиная от 23 версии и выше.
В модулей используется стандартный HTTP-Клиент + Javascript (ES5).
В модуле предусмотрен интервал раз в 5 секунд обращение к серверу API. Если в течении 25 сек. не удалось получить ответ, то модуль вернет ошибку.
Более свежий модуль от разработчика Grizzly Definova Модуль Скачать
Grizzly Definova Module
Пример реализации интеграции в Browser Automation Studio
- Создаете ресурс Definova Apikey
Тип ресурса – Строка.
Строка не должна быть пустой.
2.В функции OnApplicationStart вызываете функцию DefinovaApiCheck с параметром апи ключа (ресурс, созданный в шаге №1)
3.Функцию DefinovaCheckBalance необходимо вставлять перед выполнением полезного действия в вашем приложении. В нее передаются те же параметры, что и для следующей функции DefinovaApiSend. Данная функция проверят хватит ли пользователю баланса для осуществления полезного действия внутри приложения.
В примере справа функция вставлена перед основным полезным действием по загрузке видео на аккаунты определенного сайта.
Аналогичным образом необходимо вызывать функцию перед каждым полезным действием с вводом нужного payment_key параметра, по которому сервер определяет достаточно ли баланса на его выполнение.
4.Функцию DefinovaApiSend вставляете там, где получен результат от работы приложения, т.е в конце успешно выполненного полезного действия. Например, ваш скрипт выполнил регистрацию аккаунта и сохраняет данные для входа, в этом месте в конце подставьте данную функцию, чтобы она фиксировала сьем средств с пользователей. Точно также проделайте с любым кол-вом действий. Если действий, например, 5: лайки, подписка, комментарий, просмотр, тык по кнопке. то после каждого действия вызывайте свою функцию с передачей соответствующего параметра payment_key. Артикул SKU берется в личном кабинете на сайте после загрузки приложения.
💡 Payment Key – параметры, которые задаются вами лично в свободной форме, они должны совпадать с указанными при загрузке на сайте.
Python Example
Пример кода
import requests
params = {
‘sku’: ‘my-sku’,
‘apikey’: ‘my-api-key’,
‘payment_key’: ‘my-payment-key’
}
response = requests.post(‘https://api.definova.club/api/send’, params=params)
print(response)
Javascript Example
Пример кода
const request = require(‘request’);
const url = ‘https://api.definova.club/api/send’;
request({
method: ‘POST’,
url: url,
data: { sku: sku, apikey: apikey, payment_key: payment_key }
}).then((response) => {
console.log(response.body);
}).catch((error) => {
console.error(error);
});
Статусы Ответов
Коды ответа HTTP используются для указания общих классов успешного выполнения или ошибок.
Success Code
Error Codes
Ответы с ошибками содержат более подробную информацию об ошибке в теле ответа, в свойствах “code” и “message”.
