Документация API

Содержание

Начало работы

Быстрый старт с МЧД API

1. Получите API ключ

Зарегистрируйтесь на платформе и создайте API ключ в личном кабинете.

2. Базовый URL

https://m4d-api.ru

Для локальной разработки: http://localhost:3000

3. Формат данных

Все запросы и ответы используют формат JSON. Убедитесь, что устанавливаете заголовок Content-Type: application/json для POST запросов.

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

Как авторизоваться в API

Для аутентификации используйте Bearer токен в заголовке Authorization:

Authorization: Bearer YOUR_API_KEY

Альтернативно, можно передать ключ в query параметре:

GET /api/powers?api_key=YOUR_API_KEY

Эндпоинты API

Доступные методы API

GET/api/powers

Получить список полномочий с возможностью фильтрации

Параметры запроса:

code - фильтр по коду
name - фильтр по названию
group_id - фильтр по группе
started_after - дата начала (от)
started_before - дата начала (до)
include_revoked - включить отозванные
include_group - включить данные группы
page - номер страницы (по умолчанию: 1)
limit - записей на странице (макс: 100)

GET/api/groups

Получить иерархическое дерево или плоский список групп полномочий

Параметры запроса:

flat - вернуть плоский список (по умолчанию: false)
classifier_id - фильтр по классификатору

GET/api/classifiers

Получить список всех классификаторов полномочий с статистикой

Ответ содержит:

• Код и название классификатора
• Количество полномочий и групп
• Дата последнего обновления

GET/api/classifiers/:id

Получить детальную информацию о конкретном классификаторе с полной иерархией групп и полномочий

Параметры:

id - ID классификатора (в URL)

GET/api/hierarchy

Получить полную иерархию классификаторов, групп и полномочий в виде дерева

Параметры запроса:

classifier_id - фильтр по ID классификатора (опционально)

GET/api/search

Полнотекстовый поиск по полномочиям и группам (поиск по названию и коду)

Параметры запроса:

q - поисковый запрос (обязательный, мин. 2 символа)
limit - макс. результатов (по умолчанию: 20, макс: 50)

GET/api/exportBULK

Полный экспорт всех данных для синхронизации. Возвращает все классификаторы, группы и полномочия.

Параметры запроса:

format - формат ответа: json (по умолчанию) или csv
since - ISO дата (опционально) - получить только изменения после этой даты

Внимание: Этот эндпоинт возвращает большой объем данных. Рекомендуется использовать параметр since для инкрементальных обновлений. CSV формат удобен для импорта в Excel или базы данных.

Примеры кода

Готовые примеры для быстрой интеграции

// Установка
npm install axios

// Использование
const axios = require('axios');

const API_KEY = 'your_api_key_here';
const BASE_URL = 'https://m4d-api.ru';

async function getPowers() {
  try {
    const response = await axios.get(`${BASE_URL}/api/powers`, {
      headers: {
        'Authorization': `Bearer ${API_KEY}`
      },
      params: {
        limit: 10,
        include_group: true
      }
    });
    
    console.log('Powers:', response.data);
    return response.data;
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
}

getPowers();

Обработка ошибок

Коды ошибок и их значения

400 Bad Request

Некорректные параметры запроса

401 Unauthorized

Отсутствует или недействителен API ключ

404 Not Found

Запрашиваемый ресурс не найден

429 Too Many Requests

Превышен лимит запросов

500 Internal Server Error

Внутренняя ошибка сервера

Формат ответа с ошибкой:

{
  "error": "API key is required"
}

Лимиты запросов и тарифы

Ограничения по тарифам и стоимость подписки

Trial (Пробный период)

50 запросов (бесплатно)

Для новых пользователей. После исчерпания лимита необходимо перейти на платный тариф.

Месячная подписка

9,990 ₽/месяц - Безлимитные запросы

• Неограниченное количество API ключей
• Техническая поддержка
• Доступ к документации

Годовая подписка (Рекомендуем)

99,000 ₽/год - Безлимитные запросы

Экономия 17% по сравнению с месячной

• Неограниченное количество API ключей
• Приоритетная поддержка
• Доступ к документации

Корпоративный тариф

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

• Все возможности годового плана
• Выделенный сервер
• SLA 99.9%
• Персональный менеджер

Мониторинг лимитов: Текущее использование запросов отображается в личном кабинете. При превышении лимита API вернет HTTP 429 с информацией о лимитах в заголовках ответа.

Важно: Счетчик запросов увеличивается при каждом вызове API эндпоинтов (/api/powers, /api/groups, /api/classifiers, /api/search). Запросы к личному кабинету не учитываются.

Способы оплаты

Как оплатить подписку на сервис

1. Оплата банковской картой (ЮKassa)

Мгновенная активация подписки после успешной оплаты.

• Принимаем карты Visa, MasterCard, МИР
• Безопасная оплата через ЮKassa
• Автоматическая активация в течение 1 минуты

2. Счет на оплату (для юридических лиц)

Формирование счета и оплата на расчетный счет.

• Заполните реквизиты организации
• Скачайте счет в формате PDF
• Оплатите на расчетный счет
• Активация в течение 1 рабочего дня после поступления оплаты

Реквизиты для оплаты:

Получатель: ООО «Энси Групп»

ИНН: 7802962326

ОГРН: 1257800016638

Система налогообложения: УСН (НДС не облагается)

Важно: После оплаты счета отправьте подтверждение оплаты наsupport@m4d-api.ruдля ускорения активации подписки.

Техническая поддержка

Как связаться с нами

Email поддержка

support@m4d-api.ru

Ответ в течение 24 часов (рабочие дни)

Часто задаваемые вопросы

Как получить API ключ?

Зарегистрируйтесь на платформе и создайте ключ в личном кабинете.

Как часто обновляются данные?

Данные синхронизируются с ЕСНСИ ежедневно.

Что делать при превышении лимита?

Перейдите на платный тариф в личном кабинете для получения безлимитного доступа.

Можно ли получить возврат средств?

Да, в течение 14 дней с момента оплаты при условии использования менее 100 запросов.

OpenAPI спецификация

Полная документация в формате OpenAPI 3.0

Для интеграции с инструментами разработки и автоматической генерации клиентов используйте нашу OpenAPI спецификацию.