Public API

API для партнёрских интеграций

Стабильный контракт /api/v1 для CRM, ботов, виджетов и внешних сервисов. Внутренние маршруты /api/* не являются публичным контрактом.

Получить API-ключ Проверить health

Аутентификация

Запись и introspection требуют заголовок X-API-Key. Ключ выдаётся через Developer Portal и хранится на сервере только как SHA-256 хеш.

bash — introspection

$ curl -H "X-API-Key: cp_v1_..." \
  https://your-domain.com/api/v1/developers/me

Scopes

read:site read:news read:events write:contacts write:volunteers write:partnerships

Endpoints

GET/api/v1

Метаданные API и ссылки

GET/api/v1/health

Проверка доступности

GET/api/v1/site

Публичная конфигурация организации

GET/api/v1/news

Список опубликованных новостей

GET/api/v1/news/{id}

Одна новость

GET/api/v1/events

Список мероприятий

GET/api/v1/events/{id}

Одно мероприятие

POST/api/v1/contacts

Обращение (scope write:contacts)

POST/api/v1/volunteers

Заявка волонтёра

POST/api/v1/partnerships

Партнёрская заявка

GET/api/v1/developers/plans

Доступные планы

POST/api/v1/developers/keys

Заявка на ключ (Bearer token)

GET/api/v1/developers/me

Introspection ключа

Формат ответа

Успех: { success: true, data, meta }. Ошибка: { success: false, error, meta }. В meta — apiVersion и requestId.

response.json 200 OK

{
  "success": true,
  "data": { ... },
  "meta": {
    "apiVersion": "1.0.0",
    "requestId": "abc123",
    "pagination": { "page": 1, "limit": 20, "total": 42 }
  }
}

error.json 422

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed."
  },
  "meta": { "apiVersion": "1.0.0", "requestId": "abc123" }
}

Планы доступа

Выберите уровень доступа под ваш сценарий интеграции.

Starter

Бесплатный

0 ₽

Тестовые интеграции, read + write:contacts

1 000 req/hour
read:site, news, events
write:contacts

Начать бесплатно

Popular

Production

Платный

990 / мес

Production, расширенные лимиты, все write endpoints

10 000 req/hour
Все write endpoints
Оплата через ЮKassa

Выбрать план

Enterprise

Партнёр

Custom

Индивидуальные условия и SLA

50 000+ req/hour
Индивидуальные scopes
Договор и поддержка

Связаться

OpenAPI

Машиночитаемая схема: /api/v1/openapi.json

Вопросы по интеграции: vanysha2605@gmail.com