Документация
API Яндекс.Почты для домена

Загрузить логотип для домена

Запрос позволяет загрузить логотип для домена.

После загрузки логотип будет отображаться в интерфейсе каждого почтового ящика, в левом верхнем углу:

Файл нужно передать в формате GIF, JPEG или PNG, размер — не более 2 МБ.

Синтаксис запроса

Запрос следует отправлять по протоколу HTTPS с помощью метода POST с типом содержимого multipart/form-data.

POST /api2/admin/domain/logo/set
Host: pddimp.yandex.ru
Accept: */*
PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> Content-Length: <размер тела запроса в байтах> Content-Type
[no-highlight[

Описание

В заголовке следует указать тип multipart/form-data.

]no-highlight]
: multipart/form-data; boundary=---------------some-boundary-string-of-your-choice ---------------some-boundary-string-of-your-choice Content-Disposition
[no-highlight[

Описание

Следует указать:

  • имя домена в заголовке с именем domain;
  • параметр filename со значением logo и содержимое файла логотипа в двоичном виде в заголовке с именем file.

]no-highlight]
: form-data; name="domain" <имя домена> ---------------some-boundary-string-of-your-choice Content-Disposition
[no-highlight[

Описание

Следует указать:

  • имя домена в заголовке с именем domain;
  • параметр filename со значением logo и содержимое файла логотипа в двоичном виде в заголовке с именем file.

]no-highlight]
: form-data; name="file"; filename="logo" Content-Type: image/jpeg <содержимое файла логотипа в двоичном виде> ---------------some-boundary-string-of-your-choice

Заголовки:

НазваниеОписание
PddToken

ПДД-токен.

Content-Type

В заголовке следует указать тип multipart/form-data.

Content-Disposition

Следует указать:

  • имя домена в заголовке с именем domain;
  • параметр filename со значением logo и содержимое файла логотипа в двоичном виде в заголовке с именем file.

POST /api2/registrar/domain/logo/set
Host: pddimp.yandex.ru
Accept: */*
PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> Authorization
[no-highlight[

Описание

OAuth-токен.

]no-highlight]
: OAuth <OAuth-токен> Content-Length: <размер тела запроса в байтах> Content-Type
[no-highlight[

Описание

В заголовке следует указать тип multipart/form-data.

]no-highlight]
: multipart/form-data; boundary=---------------some-boundary-string-of-your-choice ---------------some-boundary-string-of-your-choice Content-Disposition
[no-highlight[

Описание

Следует указать:

  • имя домена в заголовке с именем domain;
  • параметр filename со значением logo и содержимое файла логотипа в двоичном виде в заголовке с именем file.

]no-highlight]
: form-data; name="domain" <имя домена> ---------------some-boundary-string-of-your-choice Content-Disposition
[no-highlight[

Описание

Следует указать:

  • имя домена в заголовке с именем domain;
  • параметр filename со значением logo и содержимое файла логотипа в двоичном виде в заголовке с именем file.

]no-highlight]
: form-data; name="file"; filename="logo" Content-Type: image/jpeg <содержимое файла логотипа в двоичном виде> ---------------some-boundary-string-of-your-choice

Заголовки:

НазваниеОписание
PddToken

ПДД-токен.

Authorization

OAuth-токен.

Content-Type

В заголовке следует указать тип multipart/form-data.

Content-Disposition

Следует указать:

  • имя домена в заголовке с именем domain;
  • параметр filename со значением logo и содержимое файла логотипа в двоичном виде в заголовке с именем file.

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

POST /api2/admin/domain/logo/set HTTP/1.1
Host: pddimp.yandex.ru
Accept: */*
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Content-Length: 301
Content-Type: multipart/form-data; boundary=----------------------------60f093b65ad7
----------------------------60f093b65ad7
Content-Disposition: form-data; name="domain"

domain.com
----------------------------60f093b65ad7
Content-Disposition: form-data; name="file"; filename="logo"
Content-Type: image/jpeg


{содержимое файла логотипа в двоичном виде}
----------------------------60f093b65ad7
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -F 'domain=domain.com' -F 'file=@local_logo_file.jpg;filename=logo' 'http://pddimp.yandex.ru/api2/admin/domain/logo/set'
POST /api2/admin/domain/logo/set HTTP/1.1
Host: pddimp.yandex.ru
Accept: */*
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
Content-Length: 301
Content-Type: multipart/form-data; boundary=----------------------------60f093b65ad7
----------------------------60f093b65ad7
Content-Disposition: form-data; name="domain"

domain.com
----------------------------60f093b65ad7
Content-Disposition: form-data; name="file"; filename="logo"
Content-Type: image/jpeg


{содержимое файла логотипа в двоичном виде}
----------------------------60f093b65ad7
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -F 'domain=domain.com' -F 'file=@local_logo_file.jpg;filename=logo' 'http://pddimp.yandex.ru/api2/admin/domain/logo/set'

Структура ответа

{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "success
[no-highlight[

Тип значения

Строка

Описание

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}", "error
[no-highlight[

Тип значения

Строка

Описание

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:

  • unknown — произошел временный сбой или ошибка работы API (повторите запрос позже).
  • no_token (no_domain, no_ip ) — не передан обязательный параметр.
  • bad_domain — имя домена не указано или не соответствует RFC.
  • prohibited — запрещенное имя домена.
  • bad_token (bad_login, bad_passwd) — передан неверный ПДД-токен (логин, пароль).
  • no_auth — не передан заголовок PddToken.
  • not_allowed — пользователю недоступна данная операция (он не является администратором этого домена).
  • blocked — домен заблокирован (например, за спам и т.п.).
  • occupied — имя домена используется другим пользователем.
  • domain_limit_reached — превышено допустимое количество подключенных доменов (50).
  • no_reply — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.

]no-highlight]
": "{код ошибки}" }
НазваниеТип значенияОписание
domain Строка

Имя домена.

success Строка

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

error Строка

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:

  • unknown — произошел временный сбой или ошибка работы API (повторите запрос позже).
  • no_token (no_domain, no_ip ) — не передан обязательный параметр.
  • bad_domain — имя домена не указано или не соответствует RFC.
  • prohibited — запрещенное имя домена.
  • bad_token (bad_login, bad_passwd) — передан неверный ПДД-токен (логин, пароль).
  • no_auth — не передан заголовок PddToken.
  • not_allowed — пользователю недоступна данная операция (он не является администратором этого домена).
  • blocked — домен заблокирован (например, за спам и т.п.).
  • occupied — имя домена используется другим пользователем.
  • domain_limit_reached — превышено допустимое количество подключенных доменов (50).
  • no_reply — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.