ОписаниеAPI

Вступление

APIинтерфейсиспользуетсядлятого,чтобыинтегрироватьвозможностисервисарассылокSendPulseв半岛客户端下载官网личныйпроектклиента。APIпредназначендляразработчиковисопровождаетсядетальнойдокументацией。

Описание

REST APIсервисаSe半岛客户端下载官网ndPulseработаетпопротоколуHTTPSипредставляетсобойнаборметодов,спомощьюкоторыхсовершаютсязапросыивозвращаютсяответыдлякаждойоперации。Все ответы приходят， виде， json， структур。

Ограничениенаколичествозапросов- 10запросоввсекунду。

Кросдоменныезапросы(например,jQuery Ajax)запрещены。

БиблиотекиAPI

Актуальные версии библиотек API наGitHubдоступны по ссылкам:

Также вы можете посмотретьдругие сторонние решения на Github．

ОсновнойURL

ВсессылкиназапросыкAPIвданнойдокументациивключаютобязательныйосновнойURL:

https://api.半岛客户端下载官网www.ekobsc.com

Авторизация

Процессавторизациивозможенприналичииперсональногоключа(токена),которымвдальнейшемдолженбытьподписанкаждыйзапроскAPI。
(Кодключатокен)передаетсявзаголовкелюбогозапросав(“标题”)кромеслучаевполучениясамоготокена,когдаэтоткоднетребуется。

Необходимыедляполученияключапараметрыможнонайтивнастройкахаккаунта,вовкладкеAPI．

ДляполученияключаотправьтеPOSTзапроспоссылке:

https://api.半岛客户端下载官网www.ekobsc.com/oauth/access_token

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

Параметр Тип Описание
grant_type 字符串 Должен быть равенclient_credentials 要求
client_id 字符串 ВашID 要求
client_secret 字符串 Ваш秘密 要求

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

{"grant_type":"client_credentials"， "client_id":"237b4af9c99d0f89bdbd876dcd5a0000"， "client_secret":"a99e7d506d3701c5c04de3db1913eeee"}

В случае успешного запроса вы получите ответ:

{“access_token”:“eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjI5NTQ4NDVjZWJlZjg5Nzk0YmYzMzk4ZDdiNTQ3OTA2MWUzNDQ2N2I5NTUwMmFlNzE1YmViZmU4MDBmNTMxMjIxMTU2MTcyOWM2MjI5NGRjIn0.eyJhdWQiOiIyMzdiNGFmOWM5OWQwZjg5YmRiZDg3NmRjZDVhMDE3ZiIsImp0aSI6IjI5NTQ4NDVjZWJlZjg5Nzk0YmYzMzk4ZDdiNTQ3OTA2MWUzNDQ2N2I5NTUwMmFlNzE1YmViZmU4MDBmNTMxMjIxMTU2MTcyOWM2MjI5NGRjIiwiaWF0IjaaNjI0NTI0OTA0LCJuYmYiOjE2MjQ1MjQ5MDQsImV4cCI6MTYyNDUyODUwNCwic3ViIjoiIiwic2NvcGVzIjpbXSwidXNlciI6eyJpZCI6Njc0MTgwNCwiZ3JvdXBfaWQiOm51bGwsInBhcmVudF9pZCI6bnVsbCwiYXJlYSI6InJlc3QifX0。“jip3sv7if1mhgmw0ogirpaw0ooii_in”，“token_type”:“Bearer”，“expires_in”:3600}

Примерключав头дляавторизациAPIизапросов:

授权:持票人eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjI5NTQ4NDVjZWJlZjg5Nzk0YmYzMzk4ZDdiNTQ3OTA2MWUzNDQ2N2I5NTUwMmFlNzE1YmViZmU4MDBmNTMxMjIxMTU2MTcyOWM2MjI5NGRjIn0.eyJhdWQiOiIyMzdiNGFmOWM5OWQwZjg5YmRiZDg3NmRjZDVhMDE3ZiIsImp0aSI6IjI5NTQ4NDVjZWJlZjg5Nzk0YmYzMzk4ZDdiNTQ3OTA2MWUzNDQ2N2I5NTUwMmFlNzE1YmViZmU4MDBmNTMxMjIxMTU2MTcyOWM2MjI5NGRjIiwiaWF0IjaaNjI0NTI0OTA0LCJuYmYiOjE2MjQ1MjQ5MDQsImV4cCI6MTYyNDUyODUwNCwic3ViIjoiIiwic2NvcGVzIjpbXSwidXNlciI6eyJpZCI6Njc0MTgwNCwiZ3JvdXBfaWQiOm51bGwsInBhcmVudF9pZCI6bnVsbCwiYXJlYSI6InJlc3QifX0.jiP3Sv7IF1mHGmW0oGIrPAw0oOiIEnC8Tb6wlWu5eVM2UrHL6RZsDlIslLSQNEvL_e50nDlgtgyfX5Qty4qlQ4XyW53FAgjwHbyQG7DJ6iVRAtVBtFNbkFVNbHvKw8zQy7WyxhICpAF8zdF8-gBHBnzuMhKSnASYEosJ9IAPqUkxQXrd8LpUSk-etzjEqcpMkbGj2M7Y0OxO4_BfRhVNU6ZcbiawD09m0A9uWoSnoZKxXw0o64PE3anJta6lFns5SDuyeGxanOtuZSS5I3umI2OOnUVzNG9_5WjCe6LPVQLAPAPt0m8S5WkI35_jCJ0A-gDBBdsgnUudGCvsDcgEog

Обратитевнимание,чтополученныйключдействителенвтечение1часаинетребуетповторногозапросаприкаждойоперации。

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

Ограничениязапросов

ПрииспользованииSe半岛客户端下载官网ndPulse APIестьлимитыиквотынаколичествозапросов。Ограничениянужны,чтобызащититьсистемуотполучениябольшегоколичестваданных,чемонаможетобработать,атакжеобеспечитьраспределениесистемныхресурсов。ЛимитынаиспользованиAPIевминутуисуткизависятоткатегориитарифногоплана,которыйподключилпользователь。

Общие лимиты квот

Втаблицеприводимограничения,которыеприменяютсянаотправкузапросовкAPI。

Категория тарифного плана Запросов， минуту Запросов， сутки Тарифные планы по сервисам
免费的 1 000 500 000 ВсебесплатныетарифныепланывсервисахSMTP,着陆页,按и聊天机器人。
标准 2 000年 1миллион Всетарифныепланымеждукатегориямии自由企业。
企业 3 000 3миллиона Дляпользователейсервисаемейловилендинговскатегорией企业,атакжесервисапушейскатегорие职业ийболе50 000еподписчиков;

дляпользователейсервисачат——ботовскатегорие职业ийболе5 000еподписчиков;
дляпользователейSMTPсервисасболе000 100еписем。

Превышение лимитов квот

Есливыпревысителимиты,APIвернетследующуюошибку:

请求太多

Чтобыотправлятьбольшезапросов,вамнеобходимоулучшитьтекущийтарифныйплан。

Коды ошибок * их описание

Кодошибки Описание
8 Отсутствуютданные
10 Отсутствует电子邮件адрес отправителя
11 Не указаны получатели
13 Отсутствует контент电子邮件сообщения
14 电子邮件адрес， заданным значением， ID， не найден
17 邮箱:адрес не найден
19 Такой电子邮件адрес уже существует
20. Пожалуйста,неиспользуйтебесплатныепочтовыесервисы
21 На активации нет указанного电子邮件адреса
97 Недопустимый тип电子邮件адреса。Использоватьаккаунтыбесплатныхпочтовыхсервисовнерекомендуется。
201 Отсутствует название адресной книги
203 Адресная книга * указанным именем уже существует
211 Адресная книга пуста
213 Адресная книга не найдена。
303 Отсутствуют电子邮件адреса， адресной книге
400 Не существует такого пользователя smtp。Вам необходимо создать аккаунт SMTP сервисе。
502 Не найден电子邮件адрес
602 Кампания не найдена。Возможно， она была уже отправлена。
701 Отсутствует电子邮件адрес или имя отправителя
703 Не найдена адресная книга
704 Не найден отправитель
707 Недостаточно средств на счету
711 Вамследуетподождать15минутпередповторнойпопыткойотправкинаданнуюадреснуюкнигу
720 Не указана тема письма
721 Отсутствует контент电子邮件сообщения
722 Не указано id адресной книги
791 Лимит api -кампаний (5) час) превышен
799 Неправильный формат даты。ДолженбытьвформатеY-m-d H:我:sинеможетбытьменьшетекущейдаты
800 Недопустимоедействие
802 Кампания не найдена
901 Не указано имя отправителя
902 Выбранный电子邮件адрес уже занят
903 Не указан电子邮件адрес отправителя
904 电子邮件адрес найден， черном списке
905 Достигнутлимитдоступногоколичестваадресовотправителя
906 Ошибка Ошибка电子邮件адресе
1101 Не указан电子邮件адрес
1003 Указанного отправителя не существует
1004 Код активации был отправлен。Вамследуетподождать15минутпередповторнойпопыткой。
1005 Ошибка при отправке подтверждения
1104 Отсутствует код активации
2020202020 Более 10 запросов 10 секунду
Baidu
map