Начало работы
Обзор документации
Как подключить Ketmus к любому проекту и начать принимать криптовалютные платежи.
Документация предназначена для специалиста, который подключает Ketmus на стороне бизнеса: разработчика, технического специалиста или владельца проекта. Здесь описаны методы API, форматы запросов и ответов, уведомления о платежах и готовые сценарии для сайта, Telegram-бота и бизнеса без разработки.
Что такое Ketmus
Ketmus — платёжный шлюз для онлайн-бизнеса, который принимает оплату в популярных криптовалютах и стейблкоинах: Bitcoin, Ethereum, USDT, USDC, TON, Solana и других — от клиентов по всему миру и без банковских ограничений.
Каждый счёт получает собственный адрес для оплаты, а Ketmus сам отслеживает поступления в блокчейне, ждёт нужное число подтверждений, пересчитывает сумму по актуальному курсу и сообщает вашему серверу о результате через подписанный вебхук.
Какой способ интеграции выбрать
| Способ | Нужен разработчик | Когда подходит | Подробнее |
|---|---|---|---|
| Merchant API | Да | Полный контроль над оплатой: создание счетов, проверка статусов, автоматическая выдача товара | Создание счёта |
| Платёжная страница | Минимально | Клиент оплачивает на готовой странице Ketmus, а затем возвращается на ваш сайт | Платёжная страница |
| Telegram-бот | Да | Продажа подписок, доступа и цифровых товаров прямо в боте | Telegram-бот |
| Статические адреса | Да | Постоянный адрес пополнения для каждого клиента без создания счёта | Статические адреса |
| Личный кабинет | Нет | Разовые счета и ссылки на оплату для клиентов, фрилансеров и B2B | Для бизнеса |
Как начать принимать платежи
- 1
Зарегистрируйтесь
Создайте аккаунт в личном кабинете Ketmus.
- 2
Создайте магазин
Добавьте магазин в разделе мерчант-сервиса: укажите название, сайт или бота и выберите монеты, которые хотите принимать.
- 3
Получите ключи
Скопируйте API-ключ магазина и секрет вебхуков. → Получение API-ключа
- 4
Настройте уведомления
Укажите URL, на который Ketmus будет отправлять вебхуки о статусах счетов. → Вебхуки
- 5
Создайте первый счёт
Отправьте запрос
POST /invoicesи перенаправьте клиента наpay_url. → Быстрый старт - 6
Проверьте интеграцию
Отправьте тестовый вебхук из кабинета и проведите небольшой реальный платёж. → Тестирование
Возможности API
- Создание счёта — выставить счёт клиенту и получить ссылку на оплату или реквизиты.
- Информация о счёте — статус, полученные суммы и транзакции.
- Список счетов — все счета магазина с фильтром по статусу.
- Отмена счёта — отменить неоплаченный счёт.
- Статические адреса — постоянный адрес пополнения для клиента.
- Баланс — балансы магазина по каждой монете.
- Монеты и сети — какие способы оплаты доступны магазину.
- Курсы — актуальные курсы криптовалют к USD и фиатным валютам.
- Вебхуки — уведомления об изменении статуса счёта на ваш сервер.
Основная информация об API
- Базовый URL:
https://app.ketmus.com/api/merchant/v1 - Формат данных — JSON, кодировка UTF-8.
- Авторизация — API-ключ магазина в заголовке
Authorization: Bearer <key>в каждом запросе. → Авторизация - Лимит — 300 запросов в минуту на один ключ. → Ошибки и лимиты
Основные понятия
| Термин | Значение |
|---|---|
| Магазин | Отдельная точка приёма платежей — сайт, бот или приложение — со своим API-ключом, настройками и статистикой |
| API-ключ | Секретный ключ магазина для авторизации запросов к API |
| Секрет вебхуков | Ключ для проверки подписи уведомлений, которые Ketmus отправляет на ваш сервер |
| Счёт (invoice) | Запрос на оплату с суммой, сроком жизни и уникальным иденти��икатором |
| Rail | Способ оплаты: конкретная монета в конкретной сети, например usdt_tron или btc |
| TXID | Хеш транзакции в блокчейне |
| Вебхук | HTTP-уведомление, которое Ketmus отправляет на ваш URL при изменении статуса счёта |
Где получить помощь
Если у вас остались вопросы, напишите в поддержку через чат в личном кабинете или на сайте Ketmus. Ответы на частые вопросы собраны в разделе Поддержка и FAQ.