Веб-сервис Linkfeed.ru (API) - Документация

Введение

Веб-сервис Linkfeed.ru (далее просто API) предназначен для получения и обработки данных пользователей участвующих в системе. Список веб-методов находится в классе ServiceController. Большинство из имеющихся там методов используют для работы структуры данных их список можно увидет внизу данной страницы в разделе "Веб-классы и структуры" или перейти к ним из описания метода.

Для удобства работы методы поделены на разделы:

Работа с API на PHP

Для работы с API необходимо установить расширения которые добавляют поддержку SOAP в PHP. В Linux это можно сделать установив пакеты php-auth и php-soap. Скорее всего есть и другие способы, но здесь они не рассмотрены.

Установить подключение к API можно используя команду (не забудьте указать свой логин и пароль):

  $client = new SoapClient("https://api.linkfeed.ru/service/wsdl", array( "trace"=> 1, "exceptions" => 0,
                           'login' => "имя пользователя", 'password' => "пароль пользователя"));

Чтобы вызвать веб-метод достаточно выполнить команду:

  $client-><Название веб-метода>(<Аргументы веб-метода>);

Название веб-метода получается путём замены первых букв метода на заглавные и удаление символов подчёркивания (в дальнейшем планируется добавить эту информацию в документацию. Пока же можно проверить имена методов открыв страницу api.linkfeed.ru/service/invoke). Например название метода get_url будет выглядеть как GetUrl. Пример:

  // Возвращает список поддерживаемый системой языков (посмотреть список в удобном для чтения формате можно используя
  // PHP комманду var_dump)
  $client->GetLanguages();

В аргументах базовые типы (такие как int, string и т.п.) можно использовать непосредственно. Например:

  $client->GetUrlLinks(123456)

Структурные типы передаются в виде хешей/массивов. Например поля name и url структуры UrlForEdit можно описать так:

  $url = array('name' => 'Новое имя URL', 'url' => 'http://example.com');

И передать его в метод edit_url так:

  $client->EditUrl(123456, $url);

Некоторые структуры могут иметь необязательные поля. Примером такой структуры является UrlForEdit, в ней мы указали только поля name и url, но не указали остальные (например auto_mode).

Методы с ограниченным доступом

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

Feedback

По причине того что текущая версия документации является бета-версией, в ней содержится немало ошибок, опечаток, неточностей, местами содержится неполная информация. Поэтому нам крайне важны ваши отзывы которые вы можете отправить на e-mail: api.doc@linkfeed.ru либо (в случае проблем с e-mail) описать проблему на форуме в посте: Веб-сервис Linkfeed.ru (API) - Документация