Внимание! Запущено тестирование FoxTools API v2.0!
Если у вас возникнут каки-либо вопросы по работе с API, вы можете оставлять их на форуме группы FoxTools.ru.IDN
Метод позволяет кодировать/декодировать IDN (Internationalized Domain Names).IDN (Internationalized Domain Names) – это доменные имена, которые могут содержать символы национальных алфавитов.
Например, домен записанный на кириллице: пример.рф, в IDN будет выглядеть как: xn--e1afmkfd.xn--p1ai.
Для кодирования доменов используется Punycode, который представляет собой стандартизированный метод преобразования последовательностей символов Unicode в ACE-последовательности, которые состоят только из символов английского алфавита, цифр, и символа дефиса (-).
Параметры
| Имя параметра | Тип | Обязательный | Описание |
|---|---|---|---|
| ACTION | Строка | Да | Действие, которое необходимо выполнить. Возможные значения: ENCODE - получить Punycode (пример.рф > xn--e1afmkfd.xn--p1ai); DECODE - прочитать Punycode (xn--e1afmkfd.xn--p1ai > пример.рф). |
| TEXT | Строка | Да | Текст, который нужно кодировать либо декодировать. Можно указывать по одному доменному имени на одной строке. В одном запросе параметр TEXT не должен содержать больше ста (100) строк. |
Общие сведения
Все команды к 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, текстовой.Для указания формата выдачи необходимо добавить к адресу страницы запроса имя желаемого формата, через слеш.
Например:
http://api.foxtools.ru/v1/IDN/xml
http://api.foxtools.ru/v1/IDN/json
http://api.foxtools.ru/v1/IDN/text
Дополнительная информация
| Состояние: | Работает |
|---|---|
| Использование: | Бесплатно |
| Всего запросов: | 4274 |
| Запросов сегодня: | 0 |
| Первый запрос: | 26.09.2012 21:51:54 |
| Последний запрос: | 19.04.2015 12:31:06 |