Обзор Developer API

Что такое Developer API

Cognivo Developer API позволяет вызывать из вашего собственного кода ту же аналитику блокчейна, на которой работают Cognivo Chat, dApp и бот в Telegram. Вы создаёте проект, создаёте API-ключ и отправляете запросы по обычному HTTPS.

1. Раздел «Разработчики» это место, где вы создаёте проекты и управляете своими ключами API Cognivo.
2. Нажмите Вход, чтобы открыть портал разработчика. Ваши ключи остаются приватными для вашего аккаунта.

Страница «Разработчики» в dApp Cognivo.Увеличить изображение

Когда его использовать

Используйте его, когда хотите получить ответы Cognivo внутри того, что вы создаёте, а не внутри Cognivo. Типичные случаи:

• Бот для сообщества, где кто-то вставляет адрес контракта и получает в ответ сигналы риска, контекст по ликвидности и блокировкам и объяснение, почему токен падает.
• Панель мониторинга для казначейства, команды или кошелька кита: экспозиция по разрешениям, недавние движения, зафиксированная прибыль и убыток по каждому токену.
• Исследовательский ноутбук, который подтягивает данные по токенам и кошелькам в Python или JavaScript для исследования или разбора инцидента.

Это не прямой доступ к ноде или RPC. Вы всегда вызываете подготовленные эндпоинты Cognivo. Здесь нет торговли, исполнения ордеров или инструментов MEV. Результаты это аналитические сигналы, а не финансовый совет, и чистый результат никогда не означает, что токен безопасен.

Где это найти

В dApp откройте боковое меню, затем Account, затем Developers. Прямая ссылка: dapp.cognivolabs.io/en/developers. Нужно войти под своим обычным аккаунтом Cognivo. Без входа страница показывает только вводный экран, без проектов и ключей.

Верх страницы Developers в dApp, где вы находите базовый URL и то, как передавать свой API-ключ.Увеличить изображение

Карточка вверху страницы несёт три вещи, которые нужны для первого вызова:

• Base URL: https://api.cognivolabs.io. Добавьте к нему путь эндпоинта, чтобы сделать запрос.
• Auth: отправляйте свой API-ключ в заголовке X-API-Key в каждом запросе. Держите ключ на своём сервере, никогда в коде браузера.
• Chains: страница показывает Ethereum, Base, and BSC live и More chains coming soon. Некоторые эндпоинты поддерживают меньше сетей, чем другие, и Справочник эндпоинтов говорит, какие именно.

Та же карточка ссылается на эту документацию и на машиночитаемую спецификацию OpenAPI, которую можно импортировать в Postman, Insomnia или в генератор SDK.

У самой страницы четыре вкладки: Quickstart, Keys, Endpoints и Usage. Endpoints это справочник с примерами, которые можно скопировать, и с ценой каждого вызова. Живого запуска на странице нет, поэтому ничто из прочитанного там ничего не тратит.

Доступ, ключи и стоимость

Живые ключи выдаются самостоятельно. Создайте ключ, и он заработает сразу, без заявки и без очереди на одобрение. Портал прямо описывает модель: некоторые эндпоинты бесплатны с любым активным ключом, а другим нужен платный или Enterprise доступ, и они оплачиваются за каждый успешный вызов с вашего баланса кредитов Cognivo.

• Живые ключи (cogv_live_) делают реальные вызовы. Каждый успешный вызов оплачивается кредитами Cognivo по цене, опубликованной для этого эндпоинта. За неудачные вызовы плата не берётся никогда. Тарификация вызовов Developer API сегодня отключена, поэтому успешный вызов ничего не списывает и баланс не меняется.
• Тестовые ключи (cogv_test_) помечены в портале как Test. У них жёсткие лимиты, и они предназначены для знакомства с API, а не для реального трафика.
• Каждый ключ показывает свой режим доступа на вкладке Keys, например Paid, Trial, Partner, Sandbox, Enterprise или Request access. Ключ в состоянии Request access должен быть одобрен, прежде чем сможет обращаться к платным эндпоинтам, а приостановленный ключ не может вызывать ничего. Портал показывает причину.
• Enterprise это единственный путь, где доступ запрашивается, ради индивидуальных цен и лимитов. Кнопка Enterprise access открывает обращение в поддержку.

Кредиты берутся с того же баланса, которым вы пользуетесь везде в Cognivo, и каждый аккаунт получает 5 бесплатных кредитов в день, они обновляются в полночь по UTC. Если вашего баланса не хватает на вызов, вы получаете ошибку 402 с кодом payment_required, и ничего не списывается. Пополните баланс и попробуйте снова. О том, как работает баланс, читайте в разделе Оплата и кредиты.

GET /v1/api/health бесплатен и не требует ключа. GET /v1/api/me бесплатен с любым действующим ключом. GET /v1/api/discover бесплатен с жёстким дневным лимитом. Цены по каждому эндпоинту есть в Справочнике эндпоинтов и в разделе Лимиты, ошибки и оплата.

Что приходит в ответ и что означает пустой ответ

Ответы несут только публичную аналитику по данным блокчейна. Они никогда не включают идентификаторы аккаунтов Cognivo, адреса электронной почты, балансы или другие приватные данные аккаунта, ни ваши, ни чужие. Единственное исключение это GET /v1/api/me, который сообщает баланс кредитов самого вызывающего ключа, чтобы вы могли следить за расходом.

Пустое поле или неизвестное значение означает, что Cognivo не смог подтвердить этот пункт для данного токена или кошелька в данной сети. Это не значит, что пункт отсутствует, и не значит, что объект чист. Считайте отсутствующий результат неподтверждённым и используйте идентификатор запроса из ответа, если нужно разобраться дальше.

Дальнейшие шаги

1. Войдите в аккаунт и создайте проект, затем создайте живой ключ. Полный ключ показывается один раз, поэтому скопируйте его сразу.
2. Сделайте свой первый вызов вместе с Быстрым стартом.
3. Прочитайте Аутентификацию и API-ключи про права, ротацию и безопасность ключей.