Описание API-интерфейса
API сервиса 3cm.kz предназначено для укорачивания ссылок посредством сервиса на других интернет-ресурсах.
При этом стоит отметить:
При этом стоит отметить:
запросы происходят через протокол HTTP по методу GET или AJAX (XMLHttpRequest);
использование API возможно только при наличии API-ключа. Для того, чтобы его получить, ждем заявки по адресу: support@kaznetmedia.kz с пометкой "Ключ API для 3cm.kz", в тексте письма укажите на каком ресурсе будет использоваться API.
1. Формат запроса:
Для получения короткой ссылки, Вам необходимо отправить запрос по ссылке:
Для получения короткой ссылки, Вам необходимо отправить запрос по ссылке:
http://3cm.kz/api/query/<api_key>/
со следующими параметрами:
<api_key> - Ваш ключ, для работы с API. Будьте внимательны ключ передается не в GET переменных, а в части ссылки.
format - Формат ответа Вашего запроса. Доступны 2 варианта ответа XML и JSON. По умолчанию формат JSON.
url - Cсылка для укорачивания.
2. Пример запроса (XML):
Ответ (XML):
http://3cm.kz/api/query/<api_key>/?format=xml&url=http://ru.wikipedia.org/wiki/API
Ответ (XML):
<?xml version="1.0" encoding="utf-8"?>
<3cm>
<url>http://3cm.kz/3051</url>
<path>3051</path>
<status>2</status>
</3cm>
<3cm>
<url>http://3cm.kz/3051</url>
<path>3051</path>
<status>2</status>
</3cm>
3. Пример запроса (JSON):
Ответ (JSON):
Статусы:
http://3cm.kz/api/query/<api_key>/?format=json&url=http://ru.wikipedia.org/wiki/API
Ответ (JSON):
{"url":"http:\/\/3cm.kz\/11b9","status":2}
Статусы:
0 - Неверный URL
1 - Внутренняя ошибка
2 - URL успешно обработан
4. Пример запроса (Plain):
Ответ (Plain):
http://3cm.kz/api/query/<api_key>/?format=plain&url=http://ru.wikipedia.org/wiki/API
Ответ (Plain):
http://3cm.kz/11b9
