Общие параметры для всех API сервисов

Все параметры можно передавать как GET, так и POST - запросом.

Запрос можно отправлять как по протоколу http:// так и по https://.

Если передан неверный запрос, возвращается HTTP-код ошибки: "400 Bad Request"

Формат ответа

Проект переходит от старого формата, когда для указания формата ответа на API передавался один из параметров: html, json, xml, sql к новому:

/api/объект/метод?параметры   - ответ a формате HTML, удобно для вывода в DIV-блок
/json/объект/метод?параметры  - ответ в json формате
/xml/объект/метод?параметры   - ответ в xml формате

Старый формат и старые адреса ещё поддерживаются, но по возможности используйте новые.

Ответ в формате json удобен для заполнения INPUT-полей или преобразования в массив для дальнейшей обработки на Javascript или PHP.
Для Вашего удобства поддерживается формат JSONP. Вы можете добавить параметр &jsonp=ИМЯ_ФУНКЦИИ:
<script type="application/javascript"
src="http://htmlweb.ru/api/service/bic/043469751?json&jsonp=parseResponse"></script>
будет возвращен следующий код:

  parseResponse({"name":"ОАО КБ \"РЕГИОНАЛЬНЫЙ КРЕДИТ\"", "city":"КОСТРОМА", ...., "limit":50});

charset - по умолчанию все данные возвращаются в кодировке utf-8, Для получения любой другой кодировки передайте её в дополнительном, необязательном параметре charset: &charset=windows-1251 или любой из ISO-8859-1, ISO-8859-15, utf-8, cp866, cp1251, cp1252, and KOI8-R. Обратите внимание, все входящие параметры так же будут конвертироваться из указанной кодировки.

fields - какие поля включать в ответ, например:
https://htmlweb.ru/geo/api.php?city=1&sql=pb_city&fields=id,name,english,area,rajon,country

short - некоторые api запросы позволяют сокращать объем возвращаемой информации, оставляя только замое необходимое.

Старый формат

В старом формате все запросы обращались на свой обработчик, например: /service/api.php?html&... и одним из параметров передавался желаемый формат ответа:

html или не задано - получить информацию в html формате, удобно для вывода в DIV-блок

json - получить информацию в json формате

xml - получить информацию в xml формате, удобно для обращения из PHP. Не нужно передавать при обращении на /xml/

sql[=имя_таблицы] - получить информацию в sql формате. Удобно для вставки информации в базу MySql с помощью phpMyAdmin.

Аутентификация

api_key - уникальный ключ, указан в вашем личном кабинете.

limit - определяет количество оставшихся запросов до конца суток для бесплатных запросов или количество запросов до окончания тарифа при платных. Ограничения на бесплатные запросы и тарификация описана здесь.


Краткое описание конкретного API метода

Только для нового формата!

Подробное описание методов может отличаться от актуального. И зачастую неудобно искать в большом мануале информация какой же параметр передать. Для получения краткой актуальной информации об API методе добавьте параметр help. Например:

http://htmlweb.ru/api/service/bic/?help

Перейти к списку всех API сервисов


.

Популярное:


Содержание:


Новое за неделю



Сейчас на сайте: 2607

Rambler's Top100