Программное использование API
Для программного использования API на сегодняшний день есть готовая библиотека .NET Framework, которая позволяет работать с API при помощи языков программирования Visual Basic .NET и C#.Скачать FoxTools.Lib.zip (версия: 1.2013.2.5)
Примеры использования библиотеки:
Visual Basic .NET
C# (Си шарп)
Общие сведения
Все команды к API необходимо делать методом POST, на этот же адрес, на котором вы находитесь в данный момент (исключая корневой арес сайта). Тип содержимого (Content-Type) при запросах к API должен быть multipart/form-data.Для доступа к API обязательно нужно передовать идентификатор и открытый ключ доступа, которые можно получить в личном кабинете на сайте http://foxtools.ru в свойствах подключенного к сервису сайта.
Параметры для доступа к API
| Имя параметра | Тип | Обязательный | Описание |
|---|---|---|---|
| ID | Целое число | Да | Уникальный идентификатор сайта в системе. |
| KEY | Guid | Да | Открытый ключ доступа к API. |
| CID | Целое число | Нет | Пользовательский идентификатор. Данный параметр можно передавать, чтобы получать более детальную статистику использования сервера. Например, в этот параметр можно передавать идентификатор пользователя в вашей БД, чтобы знать, сколько раз пользователь использовал тот или иной сервис. |
| CGRP | Целое число | Нет | Группа для пользовательских идентификаторов (CID). Вы можете использовать этот параметр для группировки статистических данных. Например, если в CID вы передаете идентификатор пользователя в вашей БД, то параметр CGRP может быть равен 1. Если в CID вы передаете идентификатор страницы на вашем сайте, то CGRP может быть равен 2. Таким образом, вы сможете выделять статистику для пользователей (CGRP = 1) и страниц (CGRP = 2). |
Примечание. Регистр символов значения не имеет. Это касается любых параметров, как имен, так и значений.
Формат ответа
Выдача результата в API возможна в трех форматах: XML (по умолчанию), JSON, текстовой.Для указания формата выдачи необходимо добавить к адресу страницы запроса имя желаемого формата, через слеш.