Общая информация по HTTP API

Авторизация в NetAngels HTTP API

Для авторизации необходимо использовать логин и пароль от вашей панели управления хостингом:

curl -X GET -H "Accept: application/json" -u "uXXXX:password" 'https://panel.netangels.ru/api/v1/user/'

Либо вы можете использовать в качестве пароля ключи API-авторизации (Управлять ключами вы можете на этой странице в панели пользователя.)

curl -X GET -H "Accept: application/json" -u "uXXXX:key" 'https://panel.netangels.ru/api/v1/user/'

Общая структура NetAngels HTTP API

Основой NetAngels HTTP API являются ресурсы. В качестве ресурса может выступать, например, зона DNS (dnszone), А-запись в DNS (adnsrecord) и т.д.

Общие методы работы с ресурсами:

• GET - получить информацию об объекте ресурса или наборе объектов
• POST - создать новый объекта ресурса
• PUT - изменить данные в объекте ресурса
• DELETE - удалить объект ресурса

Для всех ресурсов можно указывать дополнительные GET-параметры:

• limit - количество выдаваемых объектов за раз
• offset - смещение начальной позиции в выдаче объектов

curl -X GET -H "Accept: application/json" -u "uXXXX:password" 'https://panel.netangels.ru/api/v1/dnszone/?limit=5&offset=2'

Результат GET-запроса будет содержать объект «meta» с полями:

"meta": {
     "limit": 5,                                    // ограничение на количество выданных объектов (можно задать в GET-параметре)
     "next": "/api/v1/dnszone/?limit=5&offset=5",   // адрес следующего блока объектов
     "offset": 0,                                   // смещение от начала объектов (можно задать в GET-параметре)
     "previous": null,                              // адрес предыдущего блока объектов
     "total_count": 215                             // общее количество объектов
 }

В случае неудачного запроса к ресурсу будет возвращён список ошибок

{"имя_параметра_объекта": [ "Список сообщений об ошибках",.. ] }