Публичный WebSocket API

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

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"
}

Last updated