Получить данные по API

Особенности работы с API

Get-Data использует свой REST API. Для взаимодействия с ним необходимо использовать HTTP-методы:

GET - используется для чтения данных

POST - используется для создания новых данных

PUT - используется для изменения и обновления данных

DELETE - используется для удаления данных

Для вызова конкретного метода необходимо указать:

https:// - протокол

get-data.ru - адрес сервиса

/api - интерфейс

/v1 - текушая версия API

/module - название модуля

/method - название метода

?params - передоваемые параметры

Например, для получения списка всех DEF направлений конечный url будет выглядеть следующим образом:

https://get-data.ru/api/v1/def/list

В некоторых методах должны быть указаны обязательные параметры, они отмечаются *. Например, чтобы воспользоваться методом /def/phone необходимо передать обязательный параметр phone:

https://get-data.ru/api/v1/def/phone?phone=9109620110

Параметры можно передовать в одном из доступных форматов:

x-www-form-urlencoded

form-data

application/json - в заголовке обязательно необходимо указывать Content-Type: application/json

Результат венется в виде json:

{ "code": 200, "status": "ok", "count": 1, "result": [ { "code": "910", "begin": "9600000", "end": "9799999", "volume": 200000, "operator": "ПАО \"МТС\"", "region": "Ярославская обл.", "territory": "Ярославская область", "inn": 7740000076 } ], "check_time": "2024-11-22 13:26:01", "update_time": "2024-11-22 09:34:38" }

где:

code - код ответа

status - строковое описание статуса ответа

count - число записей в результирующем поле result

result - результат выполнения запроса, который представляет собой массив значений

check_time, update_time - дата проверки актуальности данных и дата обновления данных соответственно. Выводятся для данных, получаемых из внешних источников.

Обратите внимание, что массив возвращаемых значений ограничен 50 записями. Т.е. по-умолчанию всегда возвращаются 50 первых строк, удовлетворяющих параметрам запроса. Если в ответе поле count = 50, это говорит о том, что возможно не все данные присутствуют в ответе. Чтобы получить следующие 50 записей, необходимо испольовать дополнительный параметр start. Отсчет start начинается с 0, поэтому для получения следующих данных необходимо передать start=50:

https://get-data.ru/api/v1/def/list?start=50

Также в настоящее время действует ограничение на 60 запросов в секунду.

Посмотреть модули и доступные методы