API v1

_{Вопросы к техподдержке: support.lf@statusnick.com}

"api_version": "string"

"main_token": "PD1k0qeo123j4rJ"

Описание API

Название данной версии API: v1 - так нужно прописывать при обращении к скрипту.

source

Узел через который вы можете управлять определенным источником. Используя его, вы можете менять источник (статус и т.д.), создавать источник, удалять источник и проводить прочие манипуляции. Пример обращения: /api/source/create

https://lf.statusnick.com/api/source/create

{
	"main_token": "token_code",
	"api_version": "v1",
	"query_details": {
		"source_name": "name"
	}
}

https://lf.statusnick.com/api/source/get

{
	"api_version": "v1",
	"main_token": "user_token_code",
	"query_details": {
		"source_token": "source_token_code"
	}
}

Совсем навсегда, без дополнительного подтверждения.

Не забудьте перенести средства с такого источника на промо-баланс.

https://lf.statusnick.com/api/source/delete

{
	"main_token": "token_code",
	"api_version": "v1",
	"query_details": {
		"source_token": "source_token_code"
	}
}

https://lf.statusnick.com/api/source/edit_status

{
	"main_token": "token_code",
	"api_version": "v1",
	"query_details": {
		"source_token": "source_token_code",
		"source_status": "active"
	}
}

https://lf.statusnick.com/api/source/edit_tags

{
	"main_token": "token_code",
	"api_version": "v1",
	"query_details": {
		"source_token": "source_token_code",
		"source_tags": {
			"add": [
				"telegram",
				"public",
				"staffs"
			],
			"remove": [
				"alice"
			],
			"clear": true
		}
	}
}

sources

Обращение к этому узлу генерирует ответ, связанный с несколькими (а не только с одним) проверяемыми источниками. Например, /api/sources/get - возвращает список источников с основными характеристиками, а /api/sources/delete - удалит все источники.

Не следует сильно полагаться на этот узел, потому что он сделан как временное решение и может быть отключен в какой-то период, например, по достижении некоторой степени нагрузки. Лучше сохраняйте данные о созданных источниках на своей стороне. Скажем, лучше запоминать на своей стороне токен источника, чтобы потом по нему получать данные об источнике через узел source.

https://lf.statusnick.com/api/sources/get

{
	"main_token": "token_code",
	"api_version": "v1",
	"query_details": {}
}

Совсем навсегда, без дополнительного подтверждения.

Не забудьте перенести средства с таких источников на промо-баланс.

https://lf.statusnick.com/api/sources/delete

{
	"main_token": "token_code",
	"api_version": "v1"
}

balance

Узел, который позволяет работать с балансом, средствами, например, перемещать средства.

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

По умолчанию каждый созданный источник имеет общий баланс с пользователем. Это контролируется параметром source_balance_solo.

На данный момент существует два типа пользовательского баланса и один тип баланса источника: user_balance_promo, user_balance_payed, source_balance.

Будьте внимательны: все средства, возвращенные из источника, поступают на промо-баланс пользователя.

https://lf.statusnick.com/api/balance/get

{
	"main_token": "token_code",
	"api_version": "v1"
}

Это единственный способ пополнить баланс источника.

При перемещении средств внутри аккаунта, сумма после запятой (копейки) обнуляется и на доноре и на реципиенте.

https://lf.statusnick.com/api/balance/move

{
	"main_token": "token_code",
	"api_version": "v1",
	"query_details": {
		"source_token": "source_token_code",
		"direction": "source",
		"amount": 10
	}
}

https://lf.statusnick.com/api/balance/edit_solo

{
	"main_token": "token_code",
	"api_version": "v1",
	"query_details": {
		"source_token": "source_token_code",
		"source_balance_solo": "yes"
	}
}

text

В этом узле происходит проверка и предпроверка (оценка длины и стоимости) вашего текста.

Существует два основных метода: precheck - чтобы на своей стороне перед проверкой (и оплатой) ваш скрипт мог посчитать какая длина проверяемого текста по мнению нашего API, и какая конечная стоимость будет за проверку переданного текста перед непосредственно проверкой методом check.

https://lf.statusnick.com/api/text/precheck

{
	"main_token": "token_code",
	"api_version": "v1",
	"query_details": {
		"source_token": "source_token_code",
		"text": "some_1000_symbols_text"
	}
}

https://lf.statusnick.com/api/text/check

{
	"main_token": "token_code",
	"api_version": "v1",
	"query_details": {
		"source_token": "source_token_code",
		"text": "some_1000_symbols_text",
		"dictionaries": {
			"rus": [
				"heavy",
				"expletive",
				"terrorism",
				"weapon",
				"sex",
				"economic",
				"politic"
			],
			"eng": [
				"heavy"
			]
		},
		"deep_check": "yes",
		"translit_check": "yes",
		"stylized_check": "yes"
	}
}

Стоимость

Расчеты приведены в российских рублях.

C 09.01.23 стоимость каждой проверки:

• 0.000004 руб. (0.0004 коп.) - за один знак при обычной проверке
• 0.000015 руб. (0.0015 коп.) - за один знак при глубокой проверке deep_check
• 0.004 руб. (0,4 коп.) - стоимость одного обращения к API

С 07.08.24 добавлено:

• 0.000003 руб - за один знак при включении поиска стилизованного текста stylized_check

С 09.01.23:

• При подключении более 2-х словарей, за каждый последующий добавляется 0.0006 руб. (0.06 коп.).
• При включении метода translit_check, к стоимости добавляется 0.000005 руб. (0.0005 коп.) за симв.

Другими словами, при управлении через API, для вас открыта свобода настройки, каким словарями пользоваться, какие методы проверки подключать, каким образом расходовать средства. При использовании наших приложений (ботов, плагинов и т.д.) стоимость установлена набором заранее включенных методов и словарей. Смотрите описание приложений в кабинете.

Пример расчета

Вариант 1: проверим роман "Война и мир".

Этот роман удобно брать для расчета, потому что все его читали и представляют объем произведения.

Входные данные:

1. Текст: "Война и мир" - 3 млн. знаков * 0.000004 = 12 руб.
2. Если включили 'deep_check', то: 3 млн. знаков * 0.000015 = 45 руб.
3. Количество обращений к API если разделить роман на 3000 частей = 12 руб.

Другими словами, при ограничении в API v1 на количество символов в размере 1000, можно разделить проверку романа "Война и мир" на 3000 обращений к API. Тогда, с учетом стоимости обращения к API и при глубокой проверке, общая стоимость составит: 12 + 45 + 12 = 69 рублей.

Вариант 2: сообщения из чата

Этот расчет чуть сложнее предыдущего, но даст больше понимания владельцам чатов, сайтов, смс-служб и т.д..

Возьмем по максимуму обороты в условном чате. Будем считать, что длинные сообщения (более 200 знаков) пишут редко, в основном все короткие, вроде "Как дела" или какой-то анекдот в 4-5 строчек. Например, этот абзац длиной примерно 270 знаков. Много ли у вас таких сообщений?

При таком подходе все равно будем считать по искусственно завышенным показателям. Сразу вычисляем с глубокой проверкой.

Входные данные:

1. Каждую секунду в чате появляется сообщение - в сутки выйдет 86400 сообщений.
   1. 70% сообщений - 200 знаков = 86400 * 0.7 * 0.000019 * 200 = 229,824 руб.
   2. 30% сообщений - 1000 знаков = 86400 * 0.3 * 0.000019 * 1000 = 492,48 руб.
2. Суммарная стоимость всех обращений к сервису = 86400 * 0.004 = 345,6 руб.

Итого: 1067,904 (одна тысяча шестьдесят семь) рублей.

По наблюдениям, только 2-5% пользователей чата пишут сообщения, остальные пребывают в пассивном состоянии. Это значит, что для достижения подобных трат в день, необходимо, чтобы в вашем чате было - возьмем 10% активных - минимум 864 000 пользователей.