Инструкция по использованию API сервиса

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

Принцип работы:

  • Регистрируетесь на сервисе.
  • Получаете / создаете почтовый ящик, используя наши доменные имена.
  • Регистрируйтесь на сайтах, где требуется подтверждение по почте.
  • Сайт отправляет письмо на указанный Вами адрес.
  • Письмо приходит на наш SMTP сервер, обрабатывается и добавляется в базу данных.
  • Вы делаете запрос к API с MD5 хешем почтового адреса.
  • Получаете список писем или письма по одтельности.

Управление учетной записью:

При регистрации Вы получаете 100 бесплатных обращений к сервису.
Обращения списываются за:

  • создание нового почтового ящика (за вызов API с параметром action, равным new);
  • получение списка писем (за вызов API с параметром action, равным getlist);
  • получение текста отдельного письма (за вызов API с параметром action, равным getmail);
  • продление времени жизни email\а (за вызов API с параметром action, равным update).

Списание не происходит при вызове остальных функций сервиса!

1. Регистрация нового пользователя

Вызываем API с параметром action, равным reg и параметром email, равным ваша_реальная_почта:

Пример:

https://post-shift.ru/api.php?action=reg&email=name@domain.ru

Получаем ответ от сервера:

{"hash":"d6be5cce6245b61552cdc5201e0488b2"}

Где hash - хеш, необходимый для доступа к работе с сервисом.


2. Проверка оставшихся обращений / проверка баланса

Вызываем API с параметром action, равным balance и параметром hash, равным полученный_хеш_при_регистрации:

Пример:

https://post-shift.ru/api.php?action=balance&hash=d6be5cce6245b61552cdc5201e0488b2

Получаем ответ от сервера:

{"limit":100}

Где limit - число доступных обращений к функции "Получение текста письма".


Использование:

3. Создание нового ящика с жизнью на 10 минут

Вызываем API с параметром action, равным new:

https://post-shift.ru/api.php?action=new&hash=d6be5cce6245b61552cdc5201e0488b2
Если дополнительно будет указан параметр name, не равным пустоте, то почта будет создана с переданным именем, и будет жить 1 час!

Пример:

https://post-shift.ru/api.php?action=new&hash=d6be5cce6245b61552cdc5201e0488b2&name=ghfdh5rhd4
Значение параметра name не должно быть более 10 символов! Если Вы укажете более, то значение параметра будет обрезано до 10 символов!

Если мы укажем дополнительный параметр domain, то можем выбрать домен самостоятельно. Передавать можно 2 значения: "&domain=post-shift.ru" или "&domain=postshift.ru". Если этот параметр не указан, то домен для почты будет выбран случайным образом.

Получаем ответ от сервера:

{"email":"bjlokwva72@post-shift.ru","key":"faf3f53538d0b5a52222ad7ef5040068"}

Где email - наш адрес, а key - ключ, необходимый для дальнейшего доступа к почтовому ящику.


4. Получение списка писем

Вызываем API с параметром action, равным getlist и ключом key:

https://post-shift.ru/api.php?action=getlist&hash=d6be5cce6245b61552cdc5201e0488b2&key=faf3f53538d0b5a52222ad7ef5040068

Получаем ответ от сервера со списком писем на почтовом ящике:

[{"id":1,"date":"Thu, 09 Mar 2017 11:06:11 +0300","subject":" Подтверждение регистрации в ICQ?","from":"noreply@icq.com"}]

Где id - номер нашего письма в ящике, date - дата письма, subject - тема письма, from - адрес отправителя.


5. Получение текста письма

Вызываем API с параметром action, равным getmail, ключом key и номером письма (id):

https://post-shift.ru/api.php?action=getmail&hash=d6be5cce6245b61552cdc5201e0488b2&key=faf3f53538d0b5a52222ad7ef5040068&id=1

В ответ получаем текст сообщения, в том виде, в котором он пришел.

{"message":"test"}

Где message - содержание письма в ящике, с указанным id.

Если мы укажем дополнительный параметр cut=html, то в письме будут вырезаны все HTML теги, кроме ссылок. Доступно только при получении содержимого письма.

Если мы укажем дополнительный параметр base64=decode, то письмо будет декодировано, в случае если оно пришло в виде набора символов. Доступно только при получении содержимого письма.

Если мы укажем дополнительный параметр forced=1, то письмо будет возвращено в том виде, в котором оно приходит на сервер, без пост обработок. Данный параметр исправляет ошибку "Letter not found.", если при запросе через getlist письмо есть, а при запросе getmail возвращается ошибка. Доступно только при получении содержимого письма.


6. Узнать оставшееся время жизни email'а

Вызываем API с параметром action, равным livetime и ключом key:

https://post-shift.ru/api.php?action=livetime&key=faf3f53538d0b5a52222ad7ef5040068

В ответ получим кол-во секунд или сообщение об ошибке, в случае если ящика не существует:

{"error":"key_not_found"}

Где error - текст ошибки.

{"livetime":"479"}

Где key - ключ email'a, а livetime время жизни email'a.


7. Продлить время жизни до 10 минут

Вызываем API с параметром action, равным update и ключом key:

https://post-shift.ru/api.php?action=update&hash=d6be5cce6245b61552cdc5201e0488b2&key=faf3f53538d0b5a52222ad7ef5040068

В ответ получим кол-во оставшихся секунд (600) или сообщение об ошибке, в случае если ящика не существует.

Внимательно используйте данную функцию, т.к. данная функция не добавляет время, а возвращает его к отметке в 10 минут!
Если Вы генерировали имя почтового ящика, то используйте данную функцию только если время жизни Вашего ящика осталось менее 10 минут, т.к. произойдет сброс с 1 часа на 10 минут!


{"livetime":"600"}

Где key - ключ email'a, а livetime новое время жизни email'a.


8. Удалить использованный email

Вызываем API с параметром action, равным delete и ключом key:

https://post-shift.ru/api.php?action=delete&key=faf3f53538d0b5a52222ad7ef5040068

В ответ получим "OK", если нет ошибок, или сообщение об ошибке.

{"delete":"ok"}

Где key - ключ email'a, который удалили, а delete содержащее об успешном удалении.


9. Очистить email

Вызываем API с параметром action, равным clear и ключом key:

https://post-shift.ru/api.php?action=clear&key=faf3f53538d0b5a52222ad7ef5040068

В ответ получим "OK", если нет ошибок, или сообщение об ошибке.

{"clear":"ok"}

Где key - ключ email'a, который удалили, а clear содержащее об успешной очистке.


10. Получить список активных ключей от ящиков

Вызываем API с параметром action, равным getkeys и параметром hash, равным хешу пользователя, полученному при регистрации:

https://post-shift.ru/api.php?action=getkeys&hash=faf3f53538d0b5a52222ad7ef5040068

В ответ получим список активных ключей, если нет ошибок, или сообщение о том, что активных ключей не найдено.

[{"key":"faf3f53538d0b5a52222ad7ef5040068","mail":"bjlokwva72@post-shift.ru"}]

Где key - ключ email'a, который удалили, а mail сам почтовый ящик.


11. Удалить все активные emails по IP

Вызываем API с параметром action, равным deleteall:

https://post-shift.ru/api.php?action=deleteall

В ответ получим "OK", если нет ошибок, или сообщение об ошибке.

{"delete":"ok"}

Где delete сообщение об успешном удалении.


Вопросы и предложения:

Если возникли вопросы или есть предложения, напишите нам через форму обратной связи.