Создание и управление короткими ссылками. С помощью функций данного модуля можно сокращать длинные URL для использования их в своих SMS рассылках.
Создание новой короткой ссылки
https://api.mobizon.kz/service/Link/Create
Удаление коротких ссылок
https://api.mobizon.kz/service/Link/Delete
Получение ссылки
https://api.mobizon.kz/service/Link/Get
Получение статистики по ссылкам
https://api.mobizon.kz/service/Link/GetStats
Получение списка ссылок
https://api.mobizon.kz/service/Link/List
Редактрование данных короткой ссылки
https://api.mobizon.kz/service/Link/Update
https://api.mobizon.kz/service/Link/Create
data : array Параметры ссылки (обязательный параметр)
Параметр | Тип | Описание |
---|---|---|
data[fullLink] | string | Полная ссылка |
data[status] | integer | Статус ссылки (0 - неактивна, 1 - активна) |
data[expirationDate] | date | Дата окончания действия ссылки (в формате ГГГГ-ММ-ДД ), по умолчанию не ограничено |
data[comment] | string | Комментарий к ссылке |
array : Данные короткой ссылки
Поле | Тип | Описание |
---|---|---|
id | integer | Идентификатор ссылки |
code | string | Код короткой ссылки |
shortLink | string | Короткая ссылка |
Код | Описание |
---|---|
1 | Если какие либо параметры содержат неверные значения. |
curl -X POST \
'https://api.mobizon.kz/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.kz/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.kz');
// Вызов АПИ метода
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.kz/service/Link/Delete
Параметр | Тип | Описание |
---|---|---|
ids | array | Идентификаторы ссылок |
Массив данных
Поле | Тип | Описание |
---|---|---|
processed | array | Идентификаторы удаленных ссылок |
notProcessed | array | Идентификаторы неудаленных ссылок |
curl -X POST \
'https://api.mobizon.kz/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.kz/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.kz');
// Вызов АПИ метода
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.kz/service/Link/Get
(для получения необходимо передать один из параметров)
Параметр | Тип | Описание |
---|---|---|
id | integer | Идентификатор ссылки |
code | string | Код короткой ссылки |
shortLink | string | Короткая ссылка |
Массив данных
Поле | Тип | Описание |
---|---|---|
id | integer | Идентификатор ссылки |
userId | integer | Идентификатор пользователя |
partnerId | integer | Идентификатор партнера |
domainId | integer | Идентификатор домена ссылок |
status | integer | Статус ссылки (0 - неактивна, 1 - активна) |
moderatorStatus | integer | Модераторский статус ссылки (0 - заблокирована, 1 - подтверждена) |
clickCnt | integer | Кол-во кликов по ссылке |
createTs | string | Время создания ссылки |
expirationDate | string | Дата окончания действия ссылки (в формате ГГГГ-ММ-ДД ) |
code | string | Код короткой ссылки |
fullLink | string | Полная ссылка |
shortLink | string | Короткая ссылка |
comment | string | Комментарий |
moderatorComment | string | Комментарий модератора |
Код | Описание |
---|---|
2 | Если ссылка с указанным идентификатором не найдена |
12 | Eсли не передан ни один из параметров |
curl -X POST \
'https://api.mobizon.kz/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.kz/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.kz');
// Вызов АПИ метода
if ($api->call(
'link',
'get',
array(
//код короткой ссылки
'code' => 'zxc'
)
)
) {
// Получение результата выполнения метода
$result = $api->getData();
} else {
// Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}
https://api.mobizon.kz/service/Link/GetStats
Параметр | Тип | Описание |
---|---|---|
ids | array | Идентификаторы ссылок (максимальное кол-во ссылок 5) |
type | string | Тип статистики, возможные значения: monthly - кол-во кликов и редиректов помесячно, максимальный интервал для получения статистики - 3 года daily - кол-во кликов и редиректов по дням, максимальный интервал для получения статистики - 90 дней hourly - кол-во кликов и редиректов по часам, максимальный интервал для получения статистики - 1 неделя minute - кол-во кликов и редиректов по минутам, максимальный интервал для получения статистики - 3 часа |
criteria | array | Критерии поиска (см. таблицу Критерии поиска). |
Параметр | Тип | Описание |
---|---|---|
criteria[dateFrom] | string | Извлекать статистику начиная с (дата и время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС ) |
criteria[dateTo] | string | Извлекать статистику до даты (дата и время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС ) |
Для статистики по времени monthly, daily, hourly, minute:
если критерии поиска dateFrom
и dateTo
не установлены, то статистика будет извлекаться за последний максимально возможный интервал,
если установлен только один из критериев dateFrom
, или промежуток времени между dateFrom
и dateTo
превышает максимально возможный интервал,
то статистика будет извлекаться за максимально возможный интервал начиная с даты dateFrom
,
если установлен только критерий dateTo
, то статистика будет извлекаться за максимально возможный период до даты dateTo
Массив данных
Поле | Тип | Описание |
---|---|---|
items | array | Данные статистики |
totals | string | Счетчики |
Код | Описание |
---|---|
12 | Если указано более 5 идентификаторов ссылок или неверно указан тип статистики |
curl -X POST \
'https://api.mobizon.kz/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.kz/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.kz');
// Вызов АПИ метода
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.kz/service/Link/List
Параметр | Тип | Описание |
---|---|---|
criteria | array | Критерии поиска (см. таблицу Критерии поиска) |
pagination | array | Параметры постраничного вывода (см. таблицу Параметры постраничного вывода) |
sort | array | Параметры сортировки (см. таблицу Параметры сортировки) |
Параметр | Тип | Описание |
---|---|---|
status | integer | Статус ссылки (0 - неактивна, 1 - активна) |
moderatorStatus | integer | Статус модерации ссылки (0 - заблокирована, 1 - разрешена) |
createTsFrom | datetime | Дата создания ссылки с (в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС ) |
createTsTo | datetime | Дата создания ссылки по (в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС ) |
code | string | Поиск по коду короткой ссылки |
comment | string | Поиск по комментарию |
query | string | Свободный поиск по атрибутам ссылки. Запрос может состоять из нескольких слов, разделенных пробелами. Поиск будет производиться по коду короткой ссылки, кодам соответствующих длинных ссылок отслеживания и комментарию к ссылке. Искомая комбинация слов должна присутствовать в любой комбинации среди указанных полей. |
Параметр | Тип | Описание |
---|---|---|
pageSize | integer | Количество отображаемых элементов на странице |
currentPage | integer | Текущая страница |
Параметр | Описание |
---|---|
id | Идентификатор ссылки |
status | Статус ссылки (0 - неактивна, 1 - активна) |
moderatorStatus | Статус модерации ссылки (0 - заблокирована, 1 - разрешена) |
createTs | Время создания ссылки |
expirationDate | Дата окончания действия ссылки (в формате ГГГГ-ММ-ДД ) |
code | Код короткой ссылки |
fullLink | Оригинальная ссылка |
Массив данных
Поле | Тип | Описание |
---|---|---|
items | array | Список найденных ссылок (см. таблицу Список ссылок) |
totalItemCount | integer | Общее количество найденных элементов |
Каждая из ссылок содержит поля:
Поле | Тип | Описание |
---|---|---|
id | integer | Идентификатор ссылки |
status | integer | Статус ссылки (0 - неактивна, 1 - активна) |
moderatorStatus | integer | Статус модерации ссылки (0 - заблокирована, 1 - разрешена) |
createTs | string | Время создания ссылки |
expirationDate | date | Дата окончания действия ссылки (в формате ГГГГ-ММ-ДД ) |
code | string | Код короткой ссылки |
fullLink | string | Оригинальная ссылка |
shortLink | string | Короткая ссылка |
domainId | integer | Идентификатор домена короткой ссылки |
comment | string | Комментарий пользователя |
moderatorComment | string | Комментарий модератора |
curl -X POST \
'https://api.mobizon.kz/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.kz/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.kz');
// Вызов АПИ метода
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.kz/service/Link/Update
Параметр | Тип | Описание |
---|---|---|
id | integer | Идентификатор ссылки |
data | integer | Параметры ссылки (см. таблицу Параметры ссылки). |
Параметр | Тип | Описание |
---|---|---|
data[status] | integer | Статус ссылки (0 - неактивна, 1 - активна) |
data[expirationDate] | date | Дата окончания действия ссылки (в формате ГГГГ-ММ-ДД ), по умолчанию не ограничено |
data[comment] | string | Комментарий к ссылке |
string : Короткая ссылка
Код | Описание |
---|---|
1 | Если какие либо параметры содержат неверные значения. |
2 | Если ссылка с указанным идентификатором не найдена |
curl -X POST \
'https://api.mobizon.kz/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.kz/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.kz');
// Вызов АПИ метода
if ($api->call(
'link',
'update',
array(
//идентификатор ссылки
'id' => '123',
'data' => array(
//статус ссылки
'status' => '0'
)
)
)
) {
// Получение результата выполнения метода
$result = $api->getData();
} else {
// Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}