Старое API после некоторых доработок потеряла совместимость, поэтому мы решили выпустить вторую версию.
Рекомендуем использовать эту версию для написания запросов.
Отличия от старой версии:
- Новый адрес для запросов: http://<ip>:8082/rest_api/v2/
- Вместо передачи параметров в GET, перешли на POST
- Убрали из вывода результаты промежуточных вызовов (method1, method2,..), оставили только result
- Соответственно, немного поменялся схема вывода (см. соответствующий раздел)
- Модель указывается в url напрямую, например: http://<ip>:8082/rest_api/v2/Abonents/
- Атрибут запроса fields теперь не нужно маркировать номером метода. Он будет применяться к последнему объекту (возвращенному последним методом)
- Документацию (пока что только перечень доступных полей для запроса) можно посмотреть, пройдя браузером по ссылке http://<ip>:8082/rest_api/v2/
- Теперь можно в fields запрашивать вывод объектов по ссылкам (fk, m2m), обратным ссылкам и выводить property объектов, а также выводить конкретные поля этих объектов. Глубина запроса не ограничена, разделитель - двойное подчеркивание. Внимание! Django не объединяет запрос по обратной ссылке в один, поэтому он может выполняться заметно дольше для большого кол-ва объектов (например, если запросить все учетные записи у всех абонентов - будет 1 запрос для абонентов и по запросу на каждого абонента для получения его учетных записей)
Схема результата:
Формат ответа:
{"call": "/rest_api/v2/<model_name>/", "result": [<объект>, ...]}
тип поля result будет меняться в соответствии с данными (список для перечня объектов (objects.filter), словарь для 1 объекта (objects.get), значение метода при вызове метода и.т.д).
Формат ошибки:
{"call": "/rest_api/v2/<model_name>/", "error": "..."}
если в результате есть не пустое поле error, то значит запрос завершился неуспешно
Формат объекта:
{"pk": <id>, "model": "<model>", "fields": {"<field>": <value>, ...}
Если поле является ссылкой fk (например поле tarif у модели Abonents), то объект тарифа можно получить, задав fields=["tarif"], а pk тарифа, задав fields=["tarif_id"], например:
{"pk": <id>, "model": "Abonents", "fields": {"tarif": {"pk": <id тарифа>, "model": "Tarif", "fields": {<поля тарифа>}, "tarif_id": <id тарифа>}
Также, можно вывести только определенные поля тарифа через двойное подчеркивание: fields=["tarif__name"]:
{"pk": <id>, "model": "Abonents", "fields": {"tarif": {"pk": <id тарифа>, "model": "Tarif", "fields": {"name": <имя тарифа>}, "tarif_id": <id тарифа>}
Еще пример. Запрос ip адресов всех учетных записей абонента fields=["abonent_id_users__ip"]:
{"pk": <id>, "model": "Abonents", "fields": {"abonent_id_users": [{"pk": <id учетной записи>, "model": "Users", "fields": {"ip": "<ip>"}}, ...]}}
Формирование запросов:
curl -XPOST -d 'method1=objects.all&arg1={}&fields=["tarif_id","tarif","abonent_id_users__ip","attr","child_folders_count"]' http://<ip>:8082/rest_api/v2/Abonents/ -D - curl -XPOST -d 'method1=objects.all&arg1={}&fields=["tarif_id","tarif__name","tarif__reserve_plan","abonent_id_users__ip","attr","child_folders_count"]' http://<ip>:8082/rest_api/v2/Abonents/ -D -
Примеры:
Вывести абонентов, у которых есть учетная запись с ip = 127.1.2.3:
curl -XPOST -d 'method1=objects.filter&arg1={"abonent_id_users__ip":"127.1.2.3"}' http://<ip>:8082/rest_api/v2/Abonents/ -D -
или количество таких абонентов:
curl -XPOST -d 'method1=objects.filter&arg1={"abonent_id_users__ip":"127.1.2.3"}&method2=count&arg2={}' http://<ip>:8082/rest_api/v2/Abonents/ -D -
Установить абоненту с id = 45 номер квартиры 3:
curl -X POST 'http://<ip>:8082/rest_api/v2/Abonents/' --data 'method1=objects.get&arg1={"id":"45"}&method2=set&arg2={"a_home_number":"3"}&method3=save&arg3={}';