NAV
shell python php

DOMAIN

$DOMAIN =

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

Баланс

Пример запроса

curl "https://$DOMAIN/v1/user/profile" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/profile', headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/profile');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "id":1,
  "email":"[email protected]",
  "vendor":"demo",
  "default_forwarding_number":"78009005040",
  "balance":100,
  "rating":96,
  "default_country": {
    "name":"russia","iso":"ru","prefix":"+7"
  },
  "default_operator": {
    "name":""
  },
  "frozen_balance":0
}

GET - https://$DOMAIN/v1/user/profile

Возвращает данные о пользователе: почта, баланс и рейтинг.

Заголовки

Ответ

Поле Тип Описание
id number Id пользователя
email string Почта пользователя
balance number Баланс
rating number Рейтинг
default_country array Страна по-умолчанию
default_country.name string Имя страны
default_country.iso string ISO код страны
default_country.prefix string Мобильный префикс
default_operator array Оператор по умолчанию
default_operator.name string Имя оператора
frozen_balance number Замороженный баланс
default_forwarding_number string Номер для переадресации по умолчанию
vendor string Имя поставщика

История заказов

Пример запроса

curl "https://$DOMAIN/v1/user/orders?category=hosting&limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
category = 'hosting'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('category', category),
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://$DOMAIN/v1/user/orders', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$category = 'hosting';
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/orders?category=' . $category . '&limit=' . $limit . '&offset=' . $offset . '&order=' . $order . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "Data": [
    {
      "id":53533933,
      "phone":"+79085895281",
      "operator":"tele2",
      "product":"aliexpress",
      "price":2,
      "status":"BANNED",
      "expires":"2020-06-28T16:32:43.307041Z",
      "sms":[],
      "created_at":"2020-06-28T16:17:43.307041Z",
      "country":"russia"
    }
  ],
  "ProductNames":[],
  "Statuses":[],
  "Total":3
}

GET - https://$DOMAIN/v1/user/orders?category=$category

Возвращает историю заказов по выбранной категории.

Заголовки

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

Поле Тип Обязательное Описание
category query string Да Категория: 'hosting' или 'activation'
limit query string Нет Количество запрашиваемых записей
offset query string Нет Отступ запрашиваемых записей
order query string Нет Имя поля для сортировки
reverse query string Нет Реверсированный список, true / false

Ответ

Поле Тип Описание
Data array Список заказов
ProductNames array Список товаров
Statuses array Список статусов
Total number Количество заказов

История платежей

Пример запроса

curl "https://$DOMAIN/v1/user/payments?limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://$DOMAIN/v1/user/payments', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/payments?limit=' . $limit . '&offset=' . $offset . '&order=' . $order . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "Data": [
    {
      "ID":30011934,
      "TypeName":"charge",
      "ProviderName":"admin",
      "Amount":100,
      "Balance":100,
      "CreatedAt":"2020-06-24T15:37:08.149895Z"
    }
  ],
  "PaymentTypes": [{"Name":"charge"}],
  "PaymentProviders":[{"Name":"admin"}],
  "Total":1
}

GET - https://$DOMAIN/v1/user/payments

Возвращает историю платежей.

Заголовки

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

Поле Тип Обязательное Описание
limit query string Нет Количество запрашиваемых записей
offset query string Нет Отступ запрашиваемых записей
order query string Нет Имя поля для сортировки
reverse query string Нет Реверсированный список, true / false

Ответ

Поле Тип Описание
Data array Список платежей
PaymentProviders array Название платежных систем
PaymentTypes array Типы платежей
Total number Количество платежей

Товары и цены

Запрос товаров

Пример запроса

curl "https://$DOMAIN/v1/guest/products/$country/$operator" \
  -H "Accept: application/json"
import requests

country = 'russia'
operator = 'any'

headers = {
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/guest/products/' + country + '/' + operator, headers=headers)
<?php

$ch = curl_init();
$country = 'russia';
$operator= 'any';

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/guest/products/' . $country . '/' . $operator);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "1day":{"Category":"hosting","Qty":14,"Price":80},
  "vkontakte":{"Category":"activation","Qty":133,"Price":21}
}

GET - https://$DOMAIN/v1/guest/products/$country/$operator

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

Заголовки

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

Поле Тип Обязательное Описание
country query string Да Страна, "any" - любая страна
operator query string Да Оператор, "any" - любой оператор

Ответ

Поле Тип Описание
Category string activation/hosting
Qty number Доступное количество
Price number Цена

Все цены

Пример запроса

curl "https://$DOMAIN/v1/guest/prices" \
  -H "Accept: application/json"
import requests

headers = {
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/guest/prices', headers=headers)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/guest/prices');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "russia":{
    "1688":{
      "beeline":{
        "cost":4,
        "count":1260,
        "rate": 99.99
      },
      "lycamobile":{
        "cost":4,
        "count":935,
        "rate": 99.99
      },
      "matrix":{
        "cost":4,
        "count":0,
        "rate": 99.99
      }
    }
  }
}

GET - https://$DOMAIN/v1/guest/prices

Возвращает все цены всех товаров

Заголовки

Ответ

Поле Тип Описание
cost float Цена виртуального номера, два знака после запятой
count number Доступное количество
rate float Процент доставки, два знака после запятой, не указывается если меньше 20% или слишком мало заказов

Цены по стране

Пример запроса

curl "https://$DOMAIN/v1/guest/prices?country=$country" \
  -H "Accept: application/json"
import requests

country = 'russia'

headers = {
    'Accept': 'application/json',
}

params = (
    ('country', country),
)

response = requests.get('https://$DOMAIN/v1/guest/prices', headers=headers, params=params)
<?php

$ch = curl_init();
$country = 'russia';

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/guest/prices?country=' . $country);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "russia":{
    "1688":{
      "beeline":{
        "cost":4,
        "count":1260,
        "rate": 99.99
      },
      "lycamobile":{
        "cost":4,
        "count":935,
        "rate": 99.99
      },
      "matrix":{
        "cost":4,
        "count":0,
        "rate": 99.99
      }
    }
  }
}

GET - https://$DOMAIN/v1/guest/prices?country=$country

Возвращает цены товаров по стране

Заголовки

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

Поле Тип Обязательное Описание
country query string Да Название страны

Ответ

Поле Тип Описание
cost float Цена виртуального номера, два знака после запятой
count number Доступное количество
rate float Процент доставки, два знака после запятой, не указывается если меньше 20% или слишком мало заказов

Цены по товару

Пример запроса

curl "https://$DOMAIN/v1/guest/prices?product=$product" \
  -H "Accept: application/json"
import requests

product = 'telegram'

headers = {
    'Accept': 'application/json',
}

params = (
    ('product', product),
)

response = requests.get('https://$DOMAIN/v1/guest/prices', headers=headers, params=params)
<?php

$ch = curl_init();
$product = 'telegram';

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/guest/prices?product=' . $product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "telegram":{
    "afghanistan":{
      "virtual18":{
        "cost":4,
        "count":1260,
        "rate": 99.99
      },
      "virtual23":{
        "cost":4,
        "count":935,
        "rate": 99.99
      },
      "virtual4":{
        "cost":4,
        "count":0,
        "rate": 99.99
      }
    }
  }
}

GET - https://$DOMAIN/v1/guest/prices?product=$product

Возвращает цены товара для конкретного товара

Заголовки

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

Поле Тип Обязательное Описание
product query string Да Название продукта

Ответ

Поле Тип Описание
cost float Цена виртуального номера, два знака после запятой
count number Доступное количество
rate float Процент доставки, два знака после запятой, не указывается если меньше 20% или слишком мало заказов

Цены по стране и товару

Пример запроса

curl "https://$DOMAIN/v1/guest/prices?country=$country&product=$product" \
  -H "Accept: application/json"
import requests

country = 'russia'
product = 'telegram'

headers = {
    'Accept': 'application/json',
}

params = (
    ('country', country),
    ('product', product),
)

response = requests.get('https://$DOMAIN/v1/guest/prices', headers=headers, params=params)
<?php

$ch = curl_init();
$country = 'russia';
$product = 'telegram';

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/guest/prices?country=' . $country . '&product=' . $product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "russia":{
    "telegram":{
      "beeline":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "matrix":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "megafon":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "mts":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "rostelecom":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "tele2":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "virtual15":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "yota":{
        "cost":8,
        "count":0,
        "rate": 99.99
      }
    }
  }
}

GET - https://$DOMAIN/v1/guest/prices?country=$country&product=$product

Возвращает цены товаров по стране и конкретному товару

Заголовки

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

Поле Тип Обязательное Описание
country query string Да Название страны
product query string Да Название продукта

Ответ

Поле Тип Описание
cost float Цена виртуального номера, два знака после запятой
count number Доступное количество
rate float Процент доставки, два знака после запятой, не указывается если меньше 20% или слишком мало заказов

Покупки

Купить номер активации

Пример запроса

curl "https://$DOMAIN/v1/user/buy/activation/$country/$operator/$product" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
country = 'russia'
operator = 'any'
product = 'amazon'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/buy/activation/' + country + '/' + operator + '/' + product, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$country = 'russia';
$operator = 'any';
$product = 'amazon';

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/buy/activation/' . country . '/' . operator . '/' . product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "id":11631253,
  "phone":"+79000381454",
  "operator":"beeline",
  "product":"vkontakte",
  "price":21,
  "status":"PENDING",
  "expires":"2018-10-13T08:28:38.809469028Z",
  "sms":null,
  "created_at":"2018-10-13T08:13:38.809469028Z",
  "forwarding":false,
  "forwarding_number":"",
  "country":"russia"
}

GET - https://$DOMAIN/v1/user/buy/activation/$country/$operator/$product

GET - https://$DOMAIN/v1/user/buy/activation/$country/$operator/$product?forwarding=$forwarding&number=$number&reuse=$reuse&voice=$voice&ref=$ref

Заголовки

URL Параметры

Поле Тип Обязательное Описание
country query string Да Страна, "any" - любая страна
operator query string Да Оператор, "any" - любой оператор
product query string Да Название товара

Query Параметры

Поле Тип Обязательное Описание
forwarding query string Нет Включить переадресацию
number query string Нет Номер для переадресации, только российские номера, 11 цифр без знака +
reuse query string Нет Если равно "1" купить с возможностью повторно использовать номер, если доступно
voice query string Нет Если равно "1" купить с возможностью принять звонок от робота, если доступно
ref query string Нет Реферальный ключ, если Вы разработчик программного обеспечения - условия для получения ключа Вы можете прочитать здесь

Ответ

Поле Тип Описание
id number Номер заказа
phone string Номер телефона
operator string Оператор
product string Товар
price number Цена
status string Статус заказа
expires date string Когда заказ истекает
sms sms array Список смс
created_at date string Когда заказ создан
forwarding boolean Нужно или нет включать переадресацию
forwarding_number string Номер для переадресации
country string Название страны номера

Лимиты

Арендовать номер

Пример запроса

curl "https://$DOMAIN/v1/user/buy/hosting/$country/$operator/$product" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
country = 'russia'
operator = 'any'
product = 'amazon'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/buy/hosting/' + country + '/' + operator + '/' + product, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$country = 'russia';
$operator = 'any';
$product = 'amazon';

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/buy/hosting/' . country . '/' . operator . '/' . product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "id": 1,
  "phone": "+79008001122",
  "product": "1day",
  "price": 1,
  "status": "PENDING",
  "expires": "1970-12-01T03:00:00.000000Z",
  "sms": [
      {
        "id":3027531,
        "created_at":"1970-12-01T17:23:25.106597Z",
        "date":"1970-12-01T17:23:15Z",
        "sender":"Facebook",
        "text":"Use 415127 as your login code",
        "code":"415127"
      }
    ],
  "created_at": "1970-12-01T00:00:00.000000Z"
}

GET - https://$DOMAIN/v1/user/buy/hosting/$country/$operator/$product

Заголовки

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

Поле Тип Обязательное Описание
country query string Да Страна, "any" - любая страна
operator query string Да Оператор, "any" - любой оператор
product query string Да Название товара, {3hours, 1day}

Ответ

Поле Тип Описание
id number Номер заказа
phone string Номер телефона
product string Товар
price number Цена
status string Статус заказа
expires date string Когда заказ истекает
sms sms array Список смс
created_at date string Когда заказ создан

Повторно купить номер

Пример запроса

curl "https://$DOMAIN/v1/user/reuse/$product/$number" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
product = 'amazon'
number = '79006665544'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/reuse/' + product + '/' + number, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$product = 'amazon';
$number = '79006665544';

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/reuse/' . product . '/' . number);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

GET - https://$DOMAIN/v1/user/reuse/$product/$number

Заголовки

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

Поле Тип Обязательное Описание
product query string Да Название товара
number query string Да Номер телефона, 4-15 цифр (без знака +)

Ответ

Управление заказами

Прочитать заказ (Получить СМС)

Пример запроса

curl "https://$DOMAIN/v1/user/check/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/check/' + id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/check/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+79000381454",
  "product": "vkontakte",
  "price": 21,
  "status": "RECEIVED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"VKcom",
        "text":"VK: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"russia"
}

GET - https://$DOMAIN/v1/user/check/$id

Заголовки

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

Поле Тип Обязательное Описание
id query string Да Номер заказа

Ответ

Поле Тип Описание
id number Номер заказа
created_at date string Когда заказ создан
phone string Номер телефона
product string Товар
price number Цена
status string Статус заказа
expires date string Когда заказ истекает
sms sms array Список смс
forwarding boolean Нужно или нет включать переадресацию
forwarding_number string Номер для переадресации
country string Название страны номера

Завершить заказ

Пример запроса

curl "https://$DOMAIN/v1/user/finish/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/finish/' + id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/finish/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+79000381454",
  "product": "vkontakte",
  "price": 21,
  "status": "FINISHED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"VKcom",
        "text":"VK: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"russia"
}

GET - https://$DOMAIN/v1/user/finish/$id

Заголовки

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

Поле Тип Обязательное Описание
id query string Да Номер заказа

Ответ

Поле Тип Описание
id number Номер заказа
created_at date string Когда заказ создан
phone string Номер телефона
product string Товар
price number Цена
status string Статус заказа
expires date string Когда заказ истекает
sms sms array Список смс
forwarding boolean Нужно или нет включать переадресацию
forwarding_number string Номер для переадресации
country string Название страны номера

Отменить заказ

Пример запроса

curl "https://$DOMAIN/v1/user/cancel/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/cancel/' + id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/cancel/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+79000381454",
  "product": "vkontakte",
  "price": 21,
  "status": "CANCELED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"VKcom",
        "text":"VK: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"russia"
}

GET - https://$DOMAIN/v1/user/cancel/$id

Заголовки

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

Поле Тип Обязательное Описание
id query string Да Номер заказа

Ответ

Поле Тип Описание
id number Номер заказа
created_at date string Когда заказ создан
phone string Номер телефона
product string Товар
price number Цена
status string Статус заказа
expires date string Когда заказ истекает
sms sms array Список смс
forwarding boolean Нужно или нет включать переадресацию
forwarding_number string Номер для переадресации
country string Название страны номера

Бан номера

Пример запроса

curl "https://$DOMAIN/v1/user/ban/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests
token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/ban/' + id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/ban/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+79000381454",
  "product": "vkontakte",
  "price": 21,
  "status": "BANNED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"VKcom",
        "text":"VK: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"russia"
}

GET - https://$DOMAIN/v1/user/ban/$id

Заголовки

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

Поле Тип Обязательное Описание
id query string Да Номер заказа

Ответ

Поле Тип Описание
id number Номер заказа
created_at date string Когда заказ создан
phone string Номер телефона
product string Товар
price number Цена
status string Статус заказа
expires date string Когда заказ истекает
sms sms array Список смс
forwarding boolean Нужно или нет включать переадресацию
forwarding_number string Номер для переадресации
country string Название страны номера

СМС для арендованного номера

Пример запроса

curl "https://$DOMAIN/v1/user/sms/inbox/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
_id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/sms/inbox/' + _id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/sms/inbox/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "Data": [
    {
      "ID":844928,
      "created_at":"2017-09-05T15:48:33.763297Z",
      "date":"2017-09-05T15:48:27Z",
      "sender":"+79998887060",
      "text":"12345",
      "code":"",
      "is_wave":false,
      "wave_uuid":""
    }
  ],
  "Total":1
}

GET - https://$DOMAIN/v1/user/sms/inbox/$id

Возвращает список входящих SMS по номеру заказа.

Заголовки

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

Поле Тип Обязательное Описание
id query string Да Номер заказа

Ответ

Поле Тип Описание
Data array Список SMS
Total number Количество SMS

Уведомления

Уведомления

Пример запроса

curl "https://$DOMAIN/v1/guest/flash/$lang" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
lang = 'en'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/guest/flash/' + lang, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$lang = 'en';

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/guest/flash/' . lang);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "text":"...notification text..."
}

GET - https://$DOMAIN/v1/guest/flash/$lang

Заголовки

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

Поле Тип Обязательное Описание
lang query string Да Язык уведомлений, ru/en

Ответ

Поле Тип Описание
text string Текст уведомления

Поставщик

Статистика поставщика

Пример запроса

curl "https://$DOMAIN/v1/user/vendor" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/user/vendor', headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/user/vendor');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "id":1,
  "email":"[email protected]",
  "vendor":"demo",
  "default_forwarding_number":"78009005040",
  "balance":100,
  "rating":96,
  "default_country": {
    "name":"russia","iso":"ru","prefix":"+7"
  },
  "default_operator": {
    "name":""
  },
  "frozen_balance":0
}

GET - https://$DOMAIN/v1/user/vendor

Заголовки

Ответ

Поле Тип Описание
id number Id поставщика
email string Почта поставщика
balance number Баланс
rating number Рейтинг
default_country array Страна по-умолчанию
default_country.name string Имя страны
default_country.iso string ISO код страны
default_country.prefix string Мобильный префикс
default_operator array Оператор по умолчанию
default_operator.name string Имя оператора
frozen_balance number Замороженный баланс
default_forwarding_number string Номер для переадресации по умолчанию
vendor string Имя поставщика

Доступные резервы валют

Пример запроса

curl "https://$DOMAIN/v1/vendor/wallets" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://$DOMAIN/v1/vendor/wallets', headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/vendor/wallets');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "fkwallet":43339.55,
  "payeer":2117.32,
  "unitpay":97.6
}

GET - https://$DOMAIN/v1/vendor/wallets

Доступные резервы валют для партнера.

Заголовки

Ответ

Поле Тип Описание
fkwallet number
payeer number
unitpay number

История заказов поставщика

Пример запроса

curl "https://$DOMAIN/v1/vendor/orders?category=activation&limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
category = 'activation'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('category', category),
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://$DOMAIN/v1/vendor/orders', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$category = 'activation';
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/vendor/orders?category=' . $category . '&limit=' . $limit . '&offset=' . $offset . '&order=' . $id . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "Data": [],
  "ProductNames":[],
  "Statuses":[],
  "Total":3
}

GET - https://$DOMAIN/v1/vendor/orders?category=$category

Возвращает историю заказов поставщика по выбранной категории.

Заголовки

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

Поле Тип Обязательное Описание
category query string Да Категория: 'hosting' или 'activation'
limit query string Нет Количество запрашиваемых записей
offset query string Нет Отступ запрашиваемых записей
order query string Нет Имя поля для сортировки
reverse query string Нет Реверсированный список, true / false

Ответ

Поле Тип Описание
Data array Список заказов
ProductNames array Список товаров
Statuses array Список статусов
Total number Количество заказов

История платежей поставщика

Пример запроса

curl "https://$DOMAIN/v1/vendor/payments?limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://$DOMAIN/v1/vendor/payments', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://$DOMAIN/v1/vendor/payments?&limit=' . $limit . '&offset=' . $offset . '&order=' . $id . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Пример ответа

{
  "Data": [],
  "PaymentProviders":null,
  "PaymentStatuses":null,
  "PaymentTypes":null,
  "Total":3
}

GET - https://$DOMAIN/v1/vendor/payments

Возвращает историю платежей поставщика.

Заголовки

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

Поле Тип Обязательное Описание
limit query string Нет Количество запрашиваемых записей
offset query string Нет Отступ запрашиваемых записей
order query string Нет Имя поля для сортировки
reverse query string Нет Реверсированный список, true / false

Ответ

Поле Тип Описание
Data array Список платежей
PaymentProviders array Название платежных систем
PaymentStatuses array Статусы платежей
PaymentTypes array Типы платежей
Total number Количество платежей

Создать выплату

Пример запроса

curl -X POST "https://$DOMAIN/v1/vendor/withdraw" \
  -d '{"receiver":"1","method":"qiwi","amount":"1","fee":"unitpay"}' \
  -H "Authorization: Bearer $token" \
  -H "Content-Type: application/json"
import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Content-type': 'application/json',
}

data = '{"receiver":"123456","method":"qiwi","amount":"10","fee":"unitpay"}'

response = requests.post('https://$DOMAIN/v1/vendor/withdraw', headers=headers, data=data)
<?php

$token = 'Your token';

$receiver = '1';
$method = 'qiwi';
$amount = '1';
$fee = 'unitpay';

$data = array(
    'receiver' => $receiver,
    'method' => $method,
    'amount' => $amount,
    'fee' => $fee,
);

$ch = curl_init();

curl_setopt_array($ch, array(
    CURLOPT_URL => 'https://$DOMAIN/v1/vendor/withdraw',
    CURLOPT_POST => TRUE,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'),
    CURLOPT_POSTFIELDS => json_encode($data),
));

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

POST - https://$DOMAIN/v1/vendor/withdraw

Создает выплату для поставщика.

Заголовки

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

Поле Тип Обязательное Описание
receiver string Да Получатель
method string Да Способ вывода visa/qiwi/yandex
amount string Да Сумма
fee string Да Платежная система fkwallet/payeer/unitpay

Ответ

Список стран

Получить список стран

Пример ответа

{
  "afghanistan":{
    "iso":{
      "af":1
    },
    "prefix":{
      "+93":1
    },
    "text_en":"Afghanistan",
    "text_ru":"Афганистан",
    "virtual18":{
      "activation":1
    },
    "virtual21":{
      "activation":1
    },
    "virtual23":{
      "activation":1
    },
    "virtual4":{
      "activation":1
    }
  }
}

GET - https://$DOMAIN/v1/guest/countries

Возвращает список стран с доступными операторами для покупки.

Заголовки

Ответ

Поле Тип Описание
iso array ISO код страны
text_en string Название страны на английском
text_ru string Название страны на русском

Список стран

Статусы заказов

Список товаров

Активация:

Аренда:

Список операторов

Структура смс

Пример ответа

{
    "sms": [
        {
            "created_at":"1970-12-01T17:23:25.106597Z",
            "date":"1970-12-01T17:23:15Z",
            "sender":"Facebook",
            "text":"Use 415127 as your login code",
            "code":"415127"
        }
    ]
}
Поле Тип Описание
created_at date string Когда SMS создана
date date string Когда SMS получена
sender string Имя отправителя
text string Текст SMS
code string Полученный код активации

Ограничения

Рейтинг

Описание системы рейтинга.

Текущий рейтинг пользователя отображается в настройках аккаунта, вкладка "Общее".

Начальный рейтинг у новых пользователей равен 96 баллов.

Максимально возможный рейтинг 96 баллов.

Рейтинг формируется из следующих параметров:

Действия Рейтинг (баллов)
Пополнение счета +8
Завершенная покупка до истечения отведенного времени на получение кода +0.5
Автоматически завершенная покупка после истечения отведенного времени на получение кода +0.4
Таймаут -0.15
Отмененная покупка -0.1
Номер отправлен в бан -0.1

Если значение рейтинга опустится до нуля, то Вы не сможете сделать заказ на сайте в течение 24 часов. По истечению 24 часов, рейтинг вернется к начальному значению - 96 баллов.