Пользователь
Баланс
Пример запроса
curl "https://5sim.biz/v1/user/profile" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/profile
Возвращает данные о пользователе: почта, баланс и рейтинг.
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Ответ
Поле | Тип | Описание |
---|---|---|
id | number | ID пользователя |
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://5sim.biz/v1/user/orders?category=hosting&limit=15&offset=0&order=id&reverse=true" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/orders?category=$category
Возвращает историю заказов по выбранной категории.
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
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://5sim.biz/v1/user/payments?limit=15&offset=0&order=id&reverse=true" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/payments
Возвращает историю платежей.
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
limit | query string | Нет | Количество запрашиваемых записей |
offset | query string | Нет | Отступ запрашиваемых записей |
order | query string | Нет | Имя поля для сортировки |
reverse | query string | Нет | Реверсированный список, true / false |
Ответ
Поле | Тип | Описание |
---|---|---|
Data | array | Список платежей |
PaymentProviders | array | Название платежных систем |
PaymentTypes | array | Типы платежей |
Total | number | Количество платежей |
Ограничения цен
Получить список
Пример запроса
curl "https://5sim.biz/v1/user/max-prices" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
[
{
"id": 14,
"product": "telegram",
"price": 11,
"CreatedAt": "2020-06-24T15:37:08.149895Z"
}
]
GET - https://5sim.biz/v1/user/max-prices
Получить список установленных ограничений цен.
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Ответ
Поле | Тип | Описание |
---|---|---|
id | number | ID |
product | string | Название товара |
price | number | Цена |
created_at | date string | Дата и время, когда объект был создан |
Создать или обновить лимит цены для товара
Пример запроса
curl -X POST "https://5sim.biz/v1/user/max-prices" \
-d '{"product_name": "telegram", "price": 30}'\
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
POST - https://5sim.biz/v1/user/max-prices
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
product_name | query string | Да | Название товара |
price | query number | Да | Цена |
Удалить лимит цены для сервиса
Пример запроса
curl -X DELETE "https://5sim.biz/v1/user/max-prices" \
-d '{"product_name": "telegram"}'\
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
DELETE - https://5sim.biz/v1/user/max-prices
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
product_name | query string | Да | Название товара |
Товары и цены
Запрос товаров
Пример запроса
curl "https://5sim.biz/v1/guest/products/$country/$operator" \
-H "Accept: application/json"
Пример ответа
{
"1day":{"Category":"hosting","Qty":14,"Price":80},
"vkontakte":{"Category":"activation","Qty":133,"Price":21}
}
GET - https://5sim.biz/v1/guest/products/$country/$operator
Возвращает имя, цену, количество всех доступных для покупки товаров.
Заголовки
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
country | query string | Да | Страна, "any" - любая страна |
operator | query string | Да | Оператор, "any" - любой оператор |
Ответ
Поле | Тип | Описание |
---|---|---|
Category | string | activation/hosting |
Qty | number | Доступное количество |
Price | number | Цена |
Запрос цен
Пример запроса
curl "https://5sim.biz/v1/guest/prices" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/guest/prices
Возвращает все цены всех товаров
Заголовки
- Accept: application/json
Ответ
Поле | Тип | Описание |
---|---|---|
cost | float | Цена виртуального номера, два знака после запятой |
count | number | Доступное количество |
rate | float | Процент доставки, два знака после запятой, не указывается если меньше 20% или слишком мало заказов |
Цены по стране
Пример запроса
curl "https://5sim.biz/v1/guest/prices?country=$country" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/guest/prices?country=$country
Возвращает цены товаров по стране
Заголовки
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
country | query string | Да | Название страны |
Ответ
Поле | Тип | Описание |
---|---|---|
cost | float | Цена виртуального номера, два знака после запятой |
count | number | Доступное количество |
rate | float | Процент доставки, два знака после запятой, не указывается если меньше 20% или слишком мало заказов |
Цены по товару
Пример запроса
curl "https://5sim.biz/v1/guest/prices?product=$product" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/guest/prices?product=$product
Возвращает цены товара для конкретного товара
Заголовки
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
product | query string | Да | Название товара |
Ответ
Поле | Тип | Описание |
---|---|---|
cost | float | Цена виртуального номера, два знака после запятой |
count | number | Доступное количество |
rate | float | Процент доставки, два знака после запятой, не указывается если меньше 20% или слишком мало заказов |
Цены по стране и товару
Пример запроса
curl "https://5sim.biz/v1/guest/prices?country=$country&product=$product" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/guest/prices?country=$country&product=$product
Возвращает цены товаров по стране и конкретному товару
Заголовки
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
country | query string | Да | Название страны |
product | query string | Да | Название товара |
Ответ
Поле | Тип | Описание |
---|---|---|
cost | float | Цена виртуального номера, два знака после запятой |
count | number | Доступное количество |
rate | float | Процент доставки, два знака после запятой, не указывается если меньше 20% или слишком мало заказов |
Покупка
Купить номер активации
Пример запроса
curl "https://5sim.biz/v1/user/buy/activation/$country/$operator/$product" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/buy/activation/$country/$operator/$product
GET - https://5sim.biz/v1/user/buy/activation/$country/$operator/$product?forwarding=$forwarding&number=$number&reuse=$reuse&voice=$voice&ref=$ref
Заголовки
- Authorization: Bearer $token
- Accept: application/json
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 | Нет | Реферальный ключ, если Вы разработчик программного обеспечения - условия для получения ключа Вы можете прочитать здесь |
maxPrice | query string | Нет | Максимальная цена указанная в параметрах метода Покупка, имеет приоритет, над таблицей с заданной максимальной ценой и работает только, если оператор "any" |
Ответ
Поле | Тип | Описание |
---|---|---|
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 | Название страны номера |
- not enough user balance
- not enough rating
- select country
- select operator
- bad country
- bad operator
- no product
- server offline
Лимиты
Арендовать номер
Пример запроса
curl "https://5sim.biz/v1/user/buy/hosting/$country/$operator/$product" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/buy/hosting/$country/$operator/$product
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
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 | Когда заказ создан |
- no free phones
- not enough user balance
- not enough rating
- select country
- select operator
- bad country
- bad operator
- no product
- server offline
Повторно купить номер
Пример запроса
curl "https://5sim.biz/v1/user/reuse/$product/$number" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
GET - https://5sim.biz/v1/user/reuse/$product/$number
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
product | query string | Да | Название товара |
number | query string | Да | Номер телефона, 4-15 цифр (без знака +) |
Ответ
- no free phones
- select operator
- not enough user balance
- bad country
- bad operator
- server offline
- not enough rating
- no product
- reuse not possible
- reuse false
- reuse expired
Управление заказами
Прочитать заказ (Получить СМС)
Пример запроса
curl "https://5sim.biz/v1/user/check/$id" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/check/$id
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
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://5sim.biz/v1/user/finish/$id" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/finish/$id
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
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://5sim.biz/v1/user/cancel/$id" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/cancel/$id
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
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://5sim.biz/v1/user/bn/$id" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/ban/$id
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
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://5sim.biz/v1/user/sms/inbox/$id" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/sms/inbox/$id
Возвращает список входящих SMS по номеру заказа.
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
id | query string | Да | Номер заказа |
Ответ
Поле | Тип | Описание |
---|---|---|
Data | array | Список СМС |
Total | number | Количество СМС |
Уведомления
Получить уведомления
Пример запроса
curl "https://5sim.biz/v1/guest/flash/$lang" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"text":"...notification text..."
}
GET - https://5sim.biz/v1/guest/flash/$lang
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
lang | query string | Да | Язык уведомления, ru/en |
Ответ
Поле | Тип | Описание |
---|---|---|
text | string | Текст уведомления |
Поставщик
Статистика поставщика
Пример запроса
curl "https://5sim.biz/v1/user/vendor" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"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://5sim.biz/v1/user/vendor
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Ответ
Поле | Тип | Описание |
---|---|---|
id | number | ID поставщика |
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://5sim.biz/v1/vendor/wallets" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"fkwallet":43339.55,
"payeer":2117.32,
"unitpay":97.6
}
GET - https://5sim.biz/v1/vendor/wallets
Доступные резервы валют для партнера.
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Ответ
Поле | Тип | Описание |
---|---|---|
fkwallet | number | |
payeer | number | |
unitpay | number |
История заказов поставщика
Пример запроса
curl "https://5sim.biz/v1/vendor/orders?category=activation&limit=15&offset=0&order=id&reverse=true" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"Data": [],
"ProductNames":[],
"Statuses":[],
"Total":3
}
GET - https://5sim.biz/v1/vendor/orders?category=$category
Возвращает историю заказов поставщика по выбранной категории.
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
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://5sim.biz/v1/vendor/payments?limit=15&offset=0&order=id&reverse=true" \
-H "Authorization: Bearer $token" \
-H "Accept: application/json"
Пример ответа
{
"Data": [],
"PaymentProviders":null,
"PaymentStatuses":null,
"PaymentTypes":null,
"Total":3
}
GET - https://5sim.biz/v1/vendor/payments
Возвращает историю платежей поставщика.
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
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://5sim.biz/v1/vendor/withdraw" \
-d '{"receiver":"1","method":"qiwi","amount":"1","fee":"unitpay"}' \
-H "Authorization: Bearer $token" \
-H "Content-Type: application/json"
POST - https://5sim.biz/v1/vendor/withdraw
Создает выплату для поставщика.
Заголовки
- Authorization: Bearer $token
- Content-Type: application/json
Параметры запроса
Поле | Тип | Обязательное | Описание |
---|---|---|---|
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://5sim.biz/v1/guest/countries
Возвращает список стран с доступными операторами для покупки.
Заголовки
- Authorization: Bearer $token
- Accept: application/json
Ответ
Поле | Тип | Описание |
---|---|---|
iso | array | ISO код страны |
text_en | string | Название страны на английском |
text_ru | string | Название страны на русском |
Список стран
Страна | API 5SIM |
---|
Статусы заказов
- PENDING - Подготовка
- RECEIVED - Ожидание SMS
- CANCELED - Отменен
- TIMEOUT - Таймаут
- FINISHED - Завершен
- BANNED - Когда номер уже был использован или не подходит
Список товаров
Активация:
Сервис | API 5SIM |
---|
Аренда:
- 3hours
- 1day
- 10days
- 1month
Список операторов
Для того, чтобы получить список операторов нужна авторизация.
Структура СМС
Пример ответа
{
"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 баллов.