Интерфейс программирования приложений (API)

Зачем это?

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


Как это работает?

Для того, чтобы выполнить какой-либо запрос к нашему сервису, необходимо отправить POST запрос на URL http://www.newspuls.ru/api/query в следующем формате:

<?xml version="1.0" encoding="Windows-1251"?>
<action>Действие</action>
<param name="Имя параметра">Значение параметра</param>
<param name="Имя второго параметра">Значение второго параметра</param>
...
<param name="Имя n-го параметра">Значение n-го параметра</param>

Ответ придет в следующем формате:
<?xml version="1.0" encoding="Windows-1251"?>
<status>Статус запроса - success если запрос выполнен, failed если запрос выполнить не удалось</status>
<errmsg>В случае ошибки здесь выводиться сообщение об ошибке</errmsg>
<param name="Имя параметра">Значение параметра</param>
<param name="Имя второго параметра">Значение второго параметра</param>
...
<param name="Имя n-го параметра">Значение n-го параметра</param>

Действия:

Обязательные параметры для всех действий:

  1. authkey - ключ, необходимый для выполнения запроса. Его можно получить по адресу: http://www.newspuls.ru/user/panel/api/
  2. login - Имя пользователя, от которого выполняеться действие
  3. password - Зашифрованный в MD5 пароль
add_story

Добавляет новость на сайт. Есть ограничения на данный метод - он не общедоступен, необходимо чтобы карма была больше 30-ти. Это сделано с целью уменьшить количество спама на нашем сайте.

Параметры:

  1. title - Заголовок добавляемой новости, обязательный параметр
  2. url - URL добавляемой новости, обязательный параметр
  3. description - Анонс добавляемой новости, обязательный параметр
  4. category - Категория добавляемой новости, получить список возможных категорий можно следующим запросом к API: get_categories, обязательный параметр. Пример: news, internet и пр.
  5. tags - Теги(метки) к новости, дополнительный параметр, пример: tag 1, tag 2, tag 3
  6. img - URL к изображению, которое следует использовать в качестве иллюстрации к новости, дополнительный параметр
Пример запроса:
<?xml version="1.0" encoding="Windows-1251"?>

<action>add_story</action>
<param name="title">Пример использования API NewsPuls.ru</param>
<param name="url">http://example.com/</param>
<param name="description">Демонстрационный скрипт, показывающий один из вариантов использования API сервиса NewsPuls.ru</param>
<param name="category">news</param>
<param name="tags">newspuls, api</param>
<param name="authkey">1b83db0c01094d29f49bc773051beb4f</param>
<param name="login">simple_login</param>
<param name="password">7815696ecbf1c96e6894b779456d330e</param>

get_categories

Используется для получения списка категорий.

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

<?xml version="1.0" encoding="Windows-1251"?>

<action>get_categories</action>
<param name="authkey">1b83db0c01094d29f49bc773051beb4f</param>
<param name="login">simple_login</param>
<param name="password">7815696ecbf1c96e6894b779456d330e</param>


Пример ответа:
<?xml version="1.0" encoding="Windows-1251"?>

<status>success</status>
<param name="news">Новости</param>
<param name="internet">Интернет</param>
.....
<param name="miscellaneous">Разное</param>

Готовые решения
Пример использования метода add_story