Регистрация

Модуль Link

Создание и управление короткими ссылками. С помощью функций данного модуля можно сокращать длинные URL для использования их в своих SMS рассылках.

API methods

Создание новой короткой ссылки
https://api.mobizon.ua/service/Link/Create

Удаление коротких ссылок
https://api.mobizon.ua/service/Link/Delete

Получение ссылки
https://api.mobizon.ua/service/Link/Get

Получение статистики по ссылкам
https://api.mobizon.ua/service/Link/GetStats

Получение списка ссылок
https://api.mobizon.ua/service/Link/List

Редактрование данных короткой ссылки
https://api.mobizon.ua/service/Link/Update

Создание новой короткой ссылки

https://api.mobizon.ua/service/Link/Create

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

data : array Параметры ссылки (обязательный параметр)

ПараметрТипОписание
data[fullLink]stringПолная ссылка
data[status]integerСтатус ссылки (0 - неактивна, 1 - активна)
data[expirationDate]dateДата окончания действия ссылки (в формате ГГГГ-ММ-ДД), по умолчанию не ограничено
data[comment]stringКомментарий к ссылке

Ответ сервера

array : Данные короткой ссылки

ПолеТипОписание
idintegerИдентификатор ссылки
codestringКод короткой ссылки
shortLinkstringКороткая ссылка

Коды ошибок

КодОписание
1Если какие либо параметры содержат неверные значения.

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/create?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d data%5BfullLink%5D=http%3A%2F%2Fmobizon.kz&data%5Bstatus%5D=1&data%5BexpirationDate%5D=2020-10-05&data%5Bcomment%5D=%D0%9A%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9+%D0%BA+%D1%81%D1%81%D1%8B%D0%BB%D0%BA%D0%B5
var data = "data%5BfullLink%5D=http%3A%2F%2Fmobizon.kz&data%5Bstatus%5D=1&data%5BexpirationDate%5D=2020-10-05&data%5Bcomment%5D=%D0%9A%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9+%D0%BA+%D1%81%D1%81%D1%8B%D0%BB%D0%BA%D0%B5";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "'https://api.mobizon.ua/service/link/create?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'create',
    array(
        'data' => array(
            //полная ссылка
            'fullLink' => 'http://mobizon.kz',
            //статус ссылки
            'status' => '1',
            //дата окончания действия ссылки
            'expirationDate' => '2020-10-05',
            //комментарий к ссылке
            'comment' => 'Комментарий к ссылке'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Удаление коротких ссылок

https://api.mobizon.ua/service/Link/Delete

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

ПараметрТипОписание
idsarrayИдентификаторы ссылок

Ответ сервера

Массив данных

ПолеТипОписание
processedarrayИдентификаторы удаленных ссылок
notProcessedarrayИдентификаторы неудаленных ссылок

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/delete?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567
var data = "ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "'https://api.mobizon.ua/service/link/delete?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'delete',
    array(
        //идентификаторы ссылок
        'ids' => array(
            '123',
            '455',
            '567'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Получение ссылки

https://api.mobizon.ua/service/Link/Get

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

(для получения необходимо передать один из параметров)

ПараметрТипОписание
idintegerИдентификатор ссылки
codestringКод короткой ссылки
shortLinkstringКороткая ссылка

Ответ сервера

Массив данных

ПолеТипОписание
idintegerИдентификатор ссылки
userIdintegerИдентификатор пользователя
partnerIdintegerИдентификатор партнера
domainIdintegerИдентификатор домена ссылок
statusintegerСтатус ссылки (0 - неактивна, 1 - активна)
moderatorStatusintegerМодераторский статус ссылки (0 - заблокирована, 1 - подтверждена)
clickCntintegerКол-во кликов по ссылке
createTsstringВремя создания ссылки
expirationDatestringДата окончания действия ссылки (в формате ГГГГ-ММ-ДД)
codestringКод короткой ссылки
fullLinkstringПолная ссылка
shortLinkstringКороткая ссылка
commentstringКомментарий
moderatorCommentstringКомментарий модератора

Коды ошибок

КодОписание
2Если ссылка с указанным идентификатором не найдена
12Eсли не передан ни один из параметров

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/get?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d code=zxc
var data = "code=zxc";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "'https://api.mobizon.ua/service/link/get?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'get',
    array(
        //код короткой ссылки
        'code' => 'zxc'
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Получение статистики по ссылкам

https://api.mobizon.ua/service/Link/GetStats

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

ПараметрТипОписание
idsarrayИдентификаторы ссылок (максимальное кол-во ссылок 5)
typestringТип статистики, возможные значения:
monthly - кол-во кликов и редиректов помесячно, максимальный интервал для получения статистики - 3 года
daily - кол-во кликов и редиректов по дням, максимальный интервал для получения статистики - 90 дней
hourly - кол-во кликов и редиректов по часам, максимальный интервал для получения статистики - 1 неделя
minute - кол-во кликов и редиректов по минутам, максимальный интервал для получения статистики - 3 часа
criteriaarrayКритерии поиска (см. таблицу Критерии поиска).

Критерии поиска

ПараметрТипОписание
criteria[dateFrom]stringИзвлекать статистику начиная с
(дата и время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС)
criteria[dateTo]stringИзвлекать статистику до даты
(дата и время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС)

Для статистики по времени monthly, daily, hourly, minute: если критерии поиска dateFrom и dateTo не установлены, то статистика будет извлекаться за последний максимально возможный интервал, если установлен только один из критериев dateFrom, или промежуток времени между dateFrom и dateTo превышает максимально возможный интервал, то статистика будет извлекаться за максимально возможный интервал начиная с даты dateFrom, если установлен только критерий dateTo, то статистика будет извлекаться за максимально возможный период до даты dateTo

Ответ сервера

Массив данных

ПолеТипОписание
itemsarrayДанные статистики
totalsstringСчетчики

Коды ошибок

КодОписание
12Если указано более 5 идентификаторов ссылок или неверно указан тип статистики

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/getStats?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567&type=monthly&criteria%5BdateFrom%5D=2018-01-21+13%3A30%3A00
var data = "ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567&type=monthly&criteria%5BdateFrom%5D=2018-01-21+13%3A30%3A00";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "'https://api.mobizon.ua/service/link/getStats?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'getStats',
    array(
        //идентификаторы ссылок
        'ids' => array(
            '123',
            '455',
            '567'
        ),
        //тип статистики
        'type' => 'monthly',
        //критерии поиска
        'criteria' => array(
            'dateFrom' => '2018-01-21 13:30:00'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Получение списка ссылок

https://api.mobizon.ua/service/Link/List

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

ПараметрТипОписание
criteriaarrayКритерии поиска (см. таблицу Критерии поиска)
paginationarrayПараметры постраничного вывода (см. таблицу Параметры постраничного вывода)
sortarrayПараметры сортировки (см. таблицу Параметры сортировки)
Критерии поиска
ПараметрТипОписание
statusintegerСтатус ссылки (0 - неактивна, 1 - активна)
moderatorStatusintegerСтатус модерации ссылки (0 - заблокирована, 1 - разрешена)
createTsFromdatetimeДата создания ссылки с (в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС)
createTsTodatetimeДата создания ссылки по (в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС)
codestringПоиск по коду короткой ссылки
commentstringПоиск по комментарию
querystringСвободный поиск по атрибутам ссылки. Запрос может состоять из нескольких слов, разделенных пробелами. Поиск будет производиться по коду короткой ссылки, кодам соответствующих длинных ссылок отслеживания и комментарию к ссылке. Искомая комбинация слов должна присутствовать в любой комбинации среди указанных полей.
Параметры постраничного вывода
ПараметрТипОписание
pageSizeintegerКоличество отображаемых элементов на странице
currentPageintegerТекущая страница
Параметры сортировки
ПараметрОписание
idИдентификатор ссылки
statusСтатус ссылки (0 - неактивна, 1 - активна)
moderatorStatusСтатус модерации ссылки (0 - заблокирована, 1 - разрешена)
createTsВремя создания ссылки
expirationDateДата окончания действия ссылки (в формате ГГГГ-ММ-ДД)
codeКод короткой ссылки
fullLinkОригинальная ссылка

Ответ сервера

Массив данных

ПолеТипОписание
itemsarrayСписок найденных ссылок (см. таблицу Список ссылок)
totalItemCountintegerОбщее количество найденных элементов
Список ссылок

Каждая из ссылок содержит поля:

ПолеТипОписание
idintegerИдентификатор ссылки
statusintegerСтатус ссылки (0 - неактивна, 1 - активна)
moderatorStatusintegerСтатус модерации ссылки (0 - заблокирована, 1 - разрешена)
createTsstringВремя создания ссылки
expirationDatedateДата окончания действия ссылки (в формате ГГГГ-ММ-ДД)
codestringКод короткой ссылки
fullLinkstringОригинальная ссылка
shortLinkstringКороткая ссылка
domainIdintegerИдентификатор домена короткой ссылки
commentstringКомментарий пользователя
moderatorCommentstringКомментарий модератора

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/list?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d criteria%5Bstatus%5D=1&criteria%5BmoderatorStatus%5D=1&pagination%5BcurrentPage%5D=2&pagination%5BpageSize%5D=50&sort%5BclickCnt%5D=ASC
var data = "criteria%5Bstatus%5D=1&criteria%5BmoderatorStatus%5D=1&pagination%5BcurrentPage%5D=2&pagination%5BpageSize%5D=50&sort%5BclickCnt%5D=ASC";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "'https://api.mobizon.ua/service/link/list?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'list',
    array(
        //критерии поиска
        'criteria' => array(
            //только активные ссылки
            'status' => '1',
            //ссылки разрешены модератором
            'moderatorStatus' => '1'
        ),
        //параметры постраничного вывода
        'pagination' => array(
            //текущая страница
            'currentPage' => '2',
            //количество отображаемых элементов на странице
            'pageSize' => '50'
        ),
        //параметры сортировки
        'sort' => array(
            //сортировка по количеству кликов по возрастанию
            'clickCnt' => 'ASC'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Редактрование данных короткой ссылки

https://api.mobizon.ua/service/Link/Update

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

ПараметрТипОписание
idintegerИдентификатор ссылки
dataintegerПараметры ссылки (см. таблицу Параметры ссылки).

Параметры ссылки

ПараметрТипОписание
data[status]integerСтатус ссылки (0 - неактивна, 1 - активна)
data[expirationDate]dateДата окончания действия ссылки (в формате ГГГГ-ММ-ДД), по умолчанию не ограничено
data[comment]stringКомментарий к ссылке

Ответ сервера

string : Короткая ссылка

Коды ошибок

КодОписание
1Если какие либо параметры содержат неверные значения.
2Если ссылка с указанным идентификатором не найдена

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/update?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d id=123&data%5Bstatus%5D=0
var data = "id=123&data%5Bstatus%5D=0";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "'https://api.mobizon.ua/service/link/update?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'update',
    array(
        //идентификатор ссылки
        'id' => '123',
        'data' => array(
            //статус ссылки
            'status' => '0'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}
Модуль Link