📖
База знаний IPN.tools
  • ℹ️Общая информация
    • Что такое IPN?
    • Какие сети поддерживает IPN?
    • Как может выглядеть процесс оплаты для моего клиента?
    • На чьих кошельках хранятся средства?
    • Нужно ли мне проходить верификацию?
    • Что такое баланс и как его пополнить?
  • 🔧Начало работы
    • Как зарегистрироваться в IPN?
    • Как начать использовать IPN?
    • Как настроить правило, чтоб получать уведомления?
    • Как создать/обновить список адресов?
    • Как добавить сайт, чтоб получать уведомления?
    • Как настроить отправку уведомлений в Телеграм аккаунт?
    • Как получить API ключ для получения уведомлений по WebSocket?
    • Как протестировать отправку уведомлений?
  • 🧹Устранение неполадок
    • Как долго мне нужно ждать поступления средств на кошелек?
    • Клиент перевел мне средства, но я не получил уведомление
    • Не могу зарегистрироваться/войти в аккаунт IPN
  • 💡Дополнительно
    • Что такое нативная монета и в чем ее отличие от токена?
    • Что такое адрес контракта и где его найти?
    • Что такое вебхук?
  • 🖥️РАЗРАБОТЧИКАМ
    • Быстрый старт
    • Общие конечные точки
    • Публичный WebSocket API
    • IPNTools
    • EvmJsonRPC
    • TronJsonRPC
    • Уведомления
Powered by GitBook
On this page
  1. РАЗРАБОТЧИКАМ

Публичный WebSocket API

Базовой конечной точкой является wss://ipn.tools/websocket/messages

PreviousОбщие конечные точкиNextIPNTools

Last updated 1 year ago

Header params:

Field
Type
Description

Authorization

string

Пример на python:

import json

import websocket

API_KEY = "<api_key>"

ws = websocket.create_connection(
    "wss://ipn.tools/websocket/messages",
    header={"Authorization": API_KEY},
)

while True:
    result = ws.recv()
    print(json.loads(result))

Ответы приходят в формате JSON. Посмотреть пример ответа можно в разделе .

Если вы хотите получать уведомления только по конкретным правилам, отправьте запрос на фильтрацию правил, указав их идентификаторы. Чтобы узнать ID нужного правила, перейдите перейдите на страницу "Правила".

Пример на python:

import json

import websocket

API_KEY = "<api_key>"

ws = websocket.create_connection(
    "wss://ipn.tools/websocket/messages",
    header={"Authorization": API_KEY},
)

event_ids = [82, ...]

ws.send(
    json.dumps(
        {
            "command": "filter",
            "events": event_ids,
        }
    )
)
message = ws.recv()
print(message)

while True:
    result = ws.recv()
    print(json.loads(result))

Если отправка запроса на фильтрацию правил будет успешной, вы получите ответ.

{
  "type": "system message",
  "status": "success",
  "message": "The event filter has been updated"
}

🖥️
Уведомления
API ключ