API - документация

Поддерживаемый формат возвращаемых данных

Наше API в текущий момент поддерживает операции только с чтением данных, возвращаемую информацию можно получать в таких форматах

JSON

Вы можете возвращать данные в формате json
Для получения данных в формате json используйте GET параметр `type` с значением `json`

Example: "https://pavelstudio.com/api/#method#?type=json"

PLAINTEXT

Вы можете возвращать данные в формате plaintext, проще говоря `как есть`
Для получения данных без форматирования используется GET параметр `type` с значением `plaintext`, так же если не указывать параметр вовсе будет использоваться этот вариант форматирования, если это возможно для текущего метода.

Example: "https://pavelstudio.com/api/#method#?type=plaintext"

XML

Вы можете возвращать данные в формате json
Для получения данных в формате json используйте GET параметр `type` с значением `json`.

Example: "https://pavelstudio.com/api/#method#?type=json"

Возвращаемые ошибки

Возможны ситуации когда пользовательские данные введены некорректно или же по технической части выполнение запроса в текущий момент невозможно
В данной ситуации в теле метода будет возвращаться параметр `status` => false (boolean) так же `error` => 'simple text' если это возможно.

Методы

/api/ip - Получение IP

Метод возвращает IP адрес обращаемого клиента

Example: "https://pavelstudio.com/api/ip?type=json"

/api/headers - Получение HTTP заголовков клиента

Метод возвращает отправляемые клиентом HTTP заголовки, поддерживается только json/xml формат данных

Example: "https://pavelstudio.com/api/headers?type=json"

/api/domain-available - Статус домена (свободен/занят)

Проверка свободного доменного имени
Возвращаемые значения: (boolean) true/false (string) 1/0

Example: "https://pavelstudio.com/api/domain-available?domain=pavelstudio.com&type=json"

/api/response-code - Возвращение HTTP кода страницы

Возвращает произвольный HTTP ответ страницы по заданому коду.
Возвращаемое значение: *код страницы* (int)

Example: "https://pavelstudio.com/api/response-code?code=404&type=json"

/api/check-use-proxy - Проверка использования прокси

Проверяет возможность использования прокси клиентом
Возвращаемые значения: (boolean) true/false (string) 1/0

Example: "https://pavelstudio.com/api/check-use-proxy?type=json"

Использование данного API разрешается только в случае упоминания веб-ресурса автора (https://pavelstudio.com - Сервисы Для Веб-Мастеров) на всех публичных страницах где отображается используемая информация.
Запрещается использование для коммерческой деятельности без предварительного согласования с автором.