Перейти к основному содержимому

Документация для ИИ

Интеграцию с Mailganer можно поручить Cursor, Claude, ChatGPT или другому ассистенту. Чтобы он писал рабочий код, а не угадывал адреса и поля, дайте ему документацию в удобном для него виде.

Файлы для ассистента​

  • llms.txt: короткая выжимка. Базовый адрес, авторизация, лимиты, гайды и все методы со ссылками на файлы разделов.
  • Файлы разделов, например llms/subscribers.txt: все методы одного раздела с параметрами, примерами curl и ответов. Небольшие, ассистент читает их целиком.
  • llms-full.txt: вся документация одним файлом. Удобно положить в проект или приложить к чату.
  • openapi.yaml: спецификация OpenAPI 3.0, по ней можно сгенерировать клиент на любом языке.

Файлы собираются автоматически из той же спецификации, что и справочник методов, поэтому всегда актуальны.

Как подключить​

Cursor, Claude Code, Codex и другие агенты в редакторе или терминале. Самый надёжный способ: сохранить документацию в проект, тогда агент прочитает её целиком, а не по кусочкам.

curl -o mailganer-api.md https://documentation.mailganer.com/llms-full.txt

Дальше сошлитесь на файл в задаче, например @mailganer-api.md в Cursor. Если сохранять файл не хочется, дайте агенту ссылку на llms.txt: оттуда он сам перейдёт в нужный раздел.

ChatGPT, Claude и другие чаты. Скачайте llms-full.txt и приложите файлом к сообщению.

Пример запроса​

Документация API Mailganer лежит в файле mailganer-api.md.

Задача: после оформления заказа на сайте отправлять покупателю письмо с трек-номером
через триггер Mailganer. Стек: PHP 8, Laravel.

Требования:
- ключ API бери из переменной окружения MAILGANER_API_KEY;
- учитывай лимит 500 запросов в минуту, при ответе 429 повторяй запрос с паузой;
- используй только методы из документации, ничего не придумывай.

Для Python попросите ассистента использовать официальную библиотеку mailganer: в ней уже есть повторы при лимитах и обход страниц.

Безопасность ключа​

  • Не вставляйте ключ API в чат с ассистентом и не коммитьте его в репозиторий. Храните ключ в переменной окружения или в хранилище секретов.
  • По ключу доступны все методы API вашего аккаунта, включая отписку и изменение подписчиков. Если ключ попал в чужие руки, напишите нам на api@mailganer.com.
  • Проверяйте код ассистента перед запуском на боевых данных, особенно массовые изменения и отписки.