API документация

А Вы знали, что у нас есть удобная API документация?
Если нет, то тут Вы сможете найти небольшой гайд по её пользованию.

Для начала разберём, что такое API и как оно работает.

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

Простыми словами, с помощью API вы обращаетесь к нашему серверу, отправляя на него запросы.

Первый шаг в работе с нашей API обучалкой- авторизация.

Для авторизации Вам потребуется токен (API_KEY).
Он находится во вкладке «Мой профиль» в личном кабинете. После вставки токена он автоматически подставится во все запросы. Теперь мы готовы к работе.

Разберём работу с документацией на примере запроса почты.

Тут от нас требуется заполнить 2 обязательных параметра:

  • $SITE— сайт, для которого нам нужна почта (twitter.com);
  • $MAIL_TYPE— тип почты (gmail.com).

После этого нажимаем на кнопку «Выполнить«.
Ниже нам выдаст URL запрос, детали и статус запроса почты.

Из колоники «Teло ответа» можно понять:

{"status":"OK","id":"1698288999","mail":"PatricalWalkermWwklajg@gmail.com"}

Статус - ОК

ID активации - 1698288999

Почта - PatricalWalkermWwklajgf@gmail.com

Ещё тут можно посмотреть ошибки, с которыми можно встретится и их причины.

Используете BAS или ZennoPoster?

В таком случае можно не страдать и воспользоваться нашими модулями.

Нам очень важно получить от вас обратную связь!
Будем рады вас видеть в нашем телеграм чате.

api

#API

Читать еще: