Применение cURL

Оглавление

Введение
Описание

Введение

cURL — кроссплатформенная служебная программа командной строки, позволяющая взаимодействовать с множеством различных серверов по множеству различных протоколов с синтаксисом URL.

Описание

Используется для описания примеров выполнения API запросов.

Общий вид запросов

$ curl -b <cookie_file_path> \ (1)
       -X <method> \ (2)
       -H 'Content-Type: <content_type>' \ (3)
       -d '<data>' \ (4)
       <api_prefix><url_path> (5) (6)

1	<cookie_file_path> – путь до файла в который будет сохранена сессионная cookie, используется для доступа в закрытые ветки API.
2	<method> – http метода запроса.
3	<content_type> – тип содержимого которое передаются в теле запроса.
4	<data> – тело запроса.
5	<api_prefix> – префикс URL, в формате http(s)://<host>:<port>. Адрес функциональной роли webserver с включеным API.
6	<url_path> – путь до API endpoint.

Общий вид GET запроса

curl -b <cookie_file_path> \ (1)
     -G \
     --data-urlencode '<parameter>=<value>' \ (2) (3)
     <api_prefix><url_path> (4) (5)

1	<cookie_file_path> – путь до файла в который будет сохранена сессионная cookie, используется для доступа в закрытые ветки API.
2	<parameter> – параметр строки запроса.
3	<value> – значение параметра.
4	<api_prefix> – префикс URL, в формате http(s)://<host>:<port>. Адрес функциональной роли webserver с включеным API.
5	<url_path> – путь до API endpoint.

Каждый параметр указывается в отдельном параметре --data-urlencode '<parameter>=<value>'.