FAQ по Blockchain API для разработчиков
Этот FAQ отвечает на самые частые вопросы разработчиков об API Chaingateway: как пройти аутентификацию, какие сети доступны, как тестировать, как выглядят ошибки и как связаться с поддержкой. Chaingateway — это REST API, с помощью которого приложение создаёт кошельки, отправляет транзакции, читает данные блокчейна и получает вебхуки. Каждый ответ ведёт на страницу с подробностями.
Как начать работу и пройти аутентификацию?
Заголовок раздела «Как начать работу и пройти аутентификацию?»Зарегистрируйте аккаунт, создайте API-ключ в панели управления и передавайте его как Bearer-токен. Пробный период на 7 дней не требует карты. Быстрый старт проводит через первый запрос.
Что такое Chaingateway.io?
Chaingateway.io — это платформа с решениями на основе блокчейн-API, которые
позволяют разработчикам интегрировать функциональность блокчейна в свои
приложения. Один REST-интерфейс охватывает кошельки, транзакции, балансы,
блоки и вебхуки в нескольких блокчейн-сетях.
Как мне начать работу с Chaingateway.io?
Чтобы начать, зарегистрируйте аккаунт на
Chaingateway.io. После регистрации вы
сможете создать API-ключ в панели управления в разделе API tokens. Он нужен для аутентификации
ваших API-запросов. Документация содержит руководства и примеры, которые
помогут интегрировать API в ваше приложение.
Как аутентифицировать мои API-запросы?
API-запросы к Chaingateway.io необходимо аутентифицировать с помощью API-ключа. Создайте ключ в панели управления после входа в систему. Передавайте его как Bearer-токен в заголовках HTTP-запросов:
Authorization: Bearer YOUR_API_KEYЗапрос без действительного токена возвращает HTTP 401 и тело {"message":"Unauthenticated."}. Не размещайте ключ в клиентском коде или в репозитории.
Существуют ли лимиты использования для API?
Да, лимиты использования зависят от вашего тарифного плана. Планы более высокого
уровня предлагают более высокие квоты. Подробную информацию о лимитах и ценах можно найти на нашей странице тарифов.
Например, создание большего числа адресов, чем допускает ваш план, возвращает
статус 422 с сообщением Your address limit exceeded. Please upgrade your plan.
Какие сети и эндпоинты доступны?
Заголовок раздела «Какие сети и эндпоинты доступны?»API поддерживает семь блокчейнов, у каждого есть mainnet и testnet, и предлагает в них управление кошельками, обработку транзакций, вебхуки и получение данных. Поддерживаемые сети перечисляют сети и значения заголовка X-Network.
Какие блокчейн-сети поддерживаются?
Chaingateway.io поддерживает следующие блокчейн-сети:
- Ethereum (mainnet и Sepolia)
- Binance Smart Chain (mainnet и testnet)
- Bitcoin (mainnet и testnet3)
- Polygon (mainnet и Amoy)
- Tron (mainnet и Nile)
- Arbitrum (mainnet и Arbitrum Sepolia)
- Solana (mainnet и devnet)
Подробнее о том, как получить доступ к различным сетям, см. в разделе Поддерживаемые сети.
Какие виды API предлагает Chaingateway.io?
API охватывает следующие области:
- Управление кошельками: создание кошельков и управление ими.
- Обработка транзакций: отправка нативных монет и токенов, чтение транзакций.
- Instant Payment Notification: получение вебхук-уведомлений о событиях в блокчейне.
- Получение данных: запрос данных блокчейна, таких как балансы, блоки и рыночные цены.
Файл OpenAPI перечисляет более 200 операций. Справочник API описывает каждую из них.
Могу ли я протестировать API в песочнице (sandbox)?
Да, у каждого поддерживаемого блокчейна есть testnet. Добавьте заголовок X-Network: testnet, чтобы выполнить запрос в тестовой сети. Без заголовка или с X-Network: mainnet запрос выполняется в основной сети. Так вы можете протестировать интеграцию, не перемещая реальные средства.
См. Поддерживаемые сети, чтобы узнать, как получить доступ к различным сетям.
Как обрабатывать ошибки и сбои вебхуков?
Заголовок раздела «Как обрабатывать ошибки и сбои вебхуков?»Проверяйте поле ok в каждом ответе и записывайте в лог message и errors, если оно равно false. Неудачные доставки вебхуков не повторяются автоматически. Вы запрашиваете их список и отправляете повторно сами.
Как обрабатывать ошибки от API?
Если API-запрос завершается неудачно, ответ содержит статус и сообщение, указывающее на проблему. Файл OpenAPI описывает такие коды статуса:
400: Bad Request. Пример: не удалось прочитать контракт TRC20.401: Unauthorized. API-ключ недействителен или отсутствует, либо неверен пароль кошелька.404: Not Found. Пример: идентификатор вебхука, которого не существует.422: Unprocessable Entity. Запрос сформирован корректно, но валидация не прошла или блокчейн отклонил транзакцию, например из-за нехватки средств.
Подробнее см. в разделе обработки ошибок нашей документации. Мы также добавляем полезную информацию в тело ответа. Вот пример:
{ "status": 422, "ok": false, "message": "insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000", "errors": []}{ "status": 422, "ok": false, "message": "Data validation failed", "errors": { "password": ["The password field is required."] }}Как получать уведомления о входящих платежах?
Создайте вебхук запросом POST /api/v2/{chain}/webhooks. После этого Chaingateway отправляет HTTP-запрос POST на ваш URL для каждой подходящей транзакции. Вебхуки есть для Ethereum, BNB Smart Chain, Polygon, Arbitrum, TRON и Bitcoin, но не для Solana.
Неудачная доставка не повторяется автоматически. Список неудавшихся уведомлений возвращает GET /api/v2/{chain}/webhooks/notifications/failed, а повторно отправить одно из них можно запросом POST /api/v2/{chain}/webhooks/notifications/{id}/retry. См. Вебхуки и Безопасность вебхуков.
Какой тип кошелька выбрать?
Для долгоживущих адресов используйте кошелёк, защищённый паролем. Вы передаёте password при создании адреса, и последующие транзакции подписываются с этим паролем. Незащищённый кошелёк подходит только для временных адресов, потому что приватный ключ возвращается в ответе, и вы должны сохранить его сами. Chaingateway не хранит пароли и не может восстановить потерянный. Подробнее: Управление кошельками.
Где отслеживать использование и получить поддержку?
Заголовок раздела «Где отслеживать использование и получить поддержку?» Как я могу отслеживать использование API?
Вы можете отслеживать использование API из панели управления, которая предоставляет
аналитику и отчёты о количестве выполненных запросов, использовании данных и любых
возникших ошибках.
Как получить поддержку при возникновении проблем?
Для получения поддержки вы можете обратиться через наш портал поддержки, доступный в панели управления. Мы также предоставляем форум сообщества и обширную документацию, которые могут помочь решить распространённые проблемы.
По срочным вопросам обращайтесь напрямую в нашу команду поддержки по электронной почте support@chaingateway.io, через Telegram или через веб-чат на сайте.
Мы также ведём сообщество в Telegram, где вы найдёте полезные обсуждения.
Существует ли реферальная программа или программа партнёрства?
Да, мы предлагаем реферальные и партнёрские программы для разработчиков и компаний,
заинтересованных в продвижении Chaingateway.io. Подробнее см.
на нашей странице партнёрства.
Где я могу найти последние обновления и новости о Chaingateway.io?
Следите за последними новостями, выпусками функций и объявлениями, подписавшись на наш блог и нашу рассылку.
Источники
Заголовок раздела «Источники»- RFC 9110, HTTP Semantics определяет коды статуса в списке ошибок.
- RFC 6750, Bearer Token Usage определяет заголовок
Authorization: Bearer. - Файл OpenAPI перечисляет все эндпоинты с описанными ответами.