cURL utility

Alternatively to the GUI, the cURL command-line system utility (available on Linux, on Windows 10 version 1803 or later and on Windows Server 2019 or later) can be used to try out the REST API communication and functions. The command-line cURL calls have to look like this:

curl https://<procman_dns>:<procman_port>/hwm_rest_api.php --request POST --data "<instruction_parameters>" --insecure

Instead of <instruction_parameters> in the command above, URL encoded parameters (param1=val1&param2=val2&…) of a concrete REST API function have to be specified.

The parameter --insecure at the end of the command avoids that the execution ends with an error because the CA certificates are unknown, so the server certificate issuer cannot be verified. Alternatively, the CA certificates can be provided in the command in further parameters. For the full list of the parameters accepted by cURL, execute

curl --help all

from the command-line.

The first REST API function called has to be a login, which creates on success a new session and returns an authentication token for the session. The token has to be passed to every further REST API function in a parameter. At the end, the session can be closed by calling the function logout.

The following example makes a REST API login, calls two further REST API functions and closes the session. Beware, that the session authentication tokens are in the reality longer (128 characters) than in the example.

C:\>curl https://procman.my_company.com:10443/hwm_rest_api.php --request POST --data "instruction=login&data={\"user\":\"u123\",\"password\":\"u123passwd\",\"client\":\"GLOBAL\"}" --insecure
{
    "token": "0123456789ABCDEF"
}
C:\>curl https://procman.my_company.com:10443/hwm_rest_api.php --request POST --data "instruction=user_info&token=0123456789ABCDEF&data={\"user\":\"u234\"}" --insecure
{
    "id": "u234",
    "description": "John Doe",
    "company": "My Company",
    ...
    "email": "johndoe@my_company.com"
}
C:\>curl https://procman.my_company.com:10443/hwm_rest_api.php --request POST --data "instruction=process_info&token=0123456789ABCDEF&data={\"process\":\"123\"}" --insecure
{
    "general": {
        "client": "GLOBAL",
        "process": 123,
        "process_description": "Test Process",
        "process_status": "Complete",
        ...
    },
    ...
}
C:\>curl https://procman.my_company.com:10443/hwm_rest_api.php --request POST --data "instruction=logout&token=0123456789ABCDEF " --insecure
{
    "token": ""
}