Документация
Любое обращение к API возможно только POST-запросом с передачей неободимых параметров для получения данных. Для всех остальных типов запросов (GET, HEAD и т.д.) будет возвращаться 403 код ошибки сервера (403 Forbidden).
Возвращаемое значение API представляет собой всегда json-строку с данными.
Далее и ниже все приведённые примеры будут представлены на примере запроса данных через JQuery.
Обязательный параметр любого запроса к API - method
getApiVersion
Получить версию API
<script type="text/javascript">
$.ajax({
method: "POST",
url: "https://ipgeo.dev/api/",
data: {
method: "getApiVersion",
}
})
.done(function( msg ) {
console.log(msg);
});
</script>
Результатом запроса будет json-строка с номером версии API:
{"version":"1.0"}
getMethodsList
Получить список методов API
<script type="text/javascript">
$.ajax({
method: "POST",
url: "https://ipgeo.dev/api/",
data: {
method: "getMethodsList",
}
})
.done(function( msg ) {
console.log(msg);
});
</script>
Результатом запроса будет json-строка с перечислением всех доступных методов API:
{"methods":"getApiVersion,getMethodsList,getCountryList,getIsoCodes,getGeoData"}
getGeoData
Получить геоданные по IP-адресу:
<script type="text/javascript">
$.ajax({
method: "POST",
url: "https://ipgeo.dev/api/",
data: {
method: "getGeoData",
ip: "3.135.206.166",
language: "[en,ru]"
callback: "callbackName"
}
})
.done(function( msg ) {
console.log(msg);
});
</script>
Результатом запроса будет json-строка:
{"country":"US","city":"Columbus","area":"Ohio","county":"Ohio","la":39.9625,"lo":-83.0061,"ip":"3.135.206.166"}
Примечание:
Параметр ip
не является обязательным. При отсутствии этого параметра по умолчанию будет представлен IPv4 клиента.
Параметр language
не является обязательным; задаёт язык ответа, может принимать значения только ru
или en
.
При отсутствии этого параметра по умолчанию будет выставлен en
, при этом ответ будет выдан на латинице.
Параметр callback
не является обязательным; оборачивает при необходимости json-ответ callback функцией с заданным именем.
getCountryList
Позволяет получить список стран с двух-буквенным ISO-кодом.
<script type="text/javascript">
$.ajax({
method: "POST",
url: "https://ipgeo.dev/api/",
data: {
method: "getCountryList",
language: "[en,ru]"
}
})
.done(function( msg ) {
console.log(msg);
});
</script>
Результатом запроса будет json-строка с выводом списка стран, для которых определены двух-буквенные ISO-коды:
{"AB":"Abkhazia","AU":"Australia","AT":"Austria", ... }
Параметр language
не является обязательным; задаёт язык ответа, может принимать значения только ru
или en
.
При отсутствии этого параметра по умолчанию будет выставлен en
, при этом ответ будет выдан на латинице.
getIsoCodes
Позволяет получить список всех двух-буквенных ISO-кодов.
<script type="text/javascript">
$.ajax({
method: "POST",
url: "https://ipgeo.dev/api/",
data: {
method: "getIsoCodes",
}
})
.done(function( msg ) {
console.log(msg);
});
</script>
Результатом запроса будет json-строка с выводом всех двух-буквенных ISO-кодов всех стран:
{"iso":"AB,AU,AT, ... "}