SDK Reference v2.4

Документация SDK:
Python и Go

Интегрируйте Verifly в ваш стек разработки за минуты. Полная поддержка типизации, асинхронности и обработки ошибок для микросервисной архитектуры.

Начать установку Просмотреть API

🐍

Python SDK

Поддержка Python 3.9+. Асинхронные хуки и интеграция с FastAPI/Django.

pip install verifly-sdk

🐹

Go SDK

Нативная интеграция для Go 1.18+. Zero-allocation парсинг и контексты.

go get github.com/verifly/sdk-go

📦

Управление зависимостями

Мы не требуем тяжелых зависимостей. Легкий вес библиотек гарантирует отсутствие конфликтов в monorepo.

npm i @verifly/cli

Инициализация клиента

Подключение к кластеру происходит через безопасный канал с использованием API-ключа.

Python: Создание экземпляра

import verifly

client = verifly.Client(
    api_key="vk_live_8923...",
    region="ru-central-1"
)

Клиент автоматически устанавливает TLS-соединение с ближайшим узлом.

Go: Конфигурация

package main

import "github.com/verifly/sdk-go"

func main() {
    cfg := sdk.Config{
        APIKey: "vk_live_8923...",
    }
    client := sdk.NewClient(cfg)
}

Использование стандартной библиотеки `net/http` для минимизации зависимостей.

Окружение

SDK автоматически ищет переменную окружения VERIFLY_API_KEY. Если ключ не найден, инициализация завершится с ошибкой AuthError.

Методы и классы

Основной объект взаимодействия — Verifier. Он отвечает за маршрутизацию запросов и валидацию контрактов.

Метод verify(payload)

Основной метод для проверки данных. Принимает JSON-объект или структуру и возвращает результат валидации.

Input: { "id": 123, "type": "user" }
Output: { "valid": true, "errors": [] }

Метод batch_verify(list)

Пакетная обработка до 1000 записей за один вызов. Идеально для ETL-процессов и миграций данных.

В Python метод поддерживает async, в Go возвращает канал (chan) с результатами.

Обработка исключений

Надежная работа требует понимания структуры ошибок.

ValidationError

Возвращается, когда данные не соответствуют схеме. Содержит массив violations с описанием полей.

RateLimitError

HTTP 429. Возникает при превышении квоты (стандартно 60 req/min). SDK автоматически выполняет retry с backoff.

NetworkError

Проблемы соединения. Рекомендуется реализовывать circuit-breaker на уровне приложения.

Логирование и отладка

SDK предоставляет встроенный логгер, интегрированный со стандартными библиотеками logging (Python) и logrus (Go).

Как включить режим DEBUG?

Установите уровень логирования в DEBUG. Это позволит видеть сырые HTTP-запросы и ответы от серверов Verifly.

verifly.set_log_level('DEBUG')

Совместимость с OpenTelemetry

Да, SDK автоматически обогащает трейсы метаданными о верификации (время отклика, статус схемы).

Нужна помощь с интеграцией?

Наши инженеры помогут настроить SDK под ваши специфические требования за 24 часа.

Связаться с поддержкой

Документация SDK: Python и Go