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

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

API Яндекс.Почты для доменов

Документ содержит описание API-методов, предназначенных для управления доменом. Разработаны методы для управления доменом в целом и аккаунтами отдельных пользователей. Методы можно вызывать непосредственно в программном коде (например, коде вашего сайта). Для каждого метода приведено подробное описание: синтаксис, параметры, формат ответа.

Основные разделы документа:

• Управление доменом – методы, относящиеся ко всему домену: регистрация и удаление домена, операции с логотипами, управление списком администраторов.
• Аккаунты пользователей – управление почтовыми ящиками пользователей.
• Списки рассылки – управление общими для домена списками рассылки.
• Авторизация пользователей – управление авторизацией пользователей по короткоживущему OAuth токену.
• Импорт почты – управление переносом почтовых ящиков.

API DNS

Документ является справочником API-методов Яндекс.Почты, предназначенных для управления DNS вашего домена.

Описаны методы для работы с записями форматов A, AAAA, CNAME, MX, NS, SRV, TXT, SOA.

API для хостеров и регистраторов

Документ предназначен специально для хостинг-провайдеров, регистраторов и парковщиков доменов. Может быть использован как справочник API или как инструкция по подключению пользовательских доменов к Яндекс.Почте.

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

Подключение происходит автоматически (по одной кнопке) и реализовано с помощью API-методов, описанных в данном документе.