REST API client

HTTP Library that makes HTTP requests simpler and more human-friendly.

Provides functionality for convenient REST API communication including the following features:
* Utilizing HTTP methods: GET, POST, PUT, DELETE
* Saving endpoint configuration in static data (via DBISYS)
* Establishing connection without static settings (via InitializeWithURL)
* Managing security settings per endpoint (see documentation for AUTMOD)
* Logging (if activated) all verbose information (request, response, debug data)

How to use it:

1. To have endpoint settings stored - add instance of RSTMOD to DBISYS\SYSGRP with object name related to endpoint.
E.g: RSTMOD : RSTXLS

2. Add description of the endpoint via SYSTBL to codetable RSTSRV. E.g:
RSTXLS - Excel Handler

3. Neccessary panels for configuration will appear automaticaly in DBISYS. Configure endpoint and save settings

4. Add the same instance (i.e. RSTMOD : RSTXLS) to the place where the API communication should take place

5. To have HTTP-communication with configured endpoint - the following commands to be executed:

- Load settings (mandatory to call before any other command)

RSTXLS.Initialize  

- Add nodes to URL:

RSTXLS.AddToUrl( <url node> )

- Add parameters to URL:

RSTXLS.AddParToUrl( <name>, <value> )

- Add parameters to Header of the request

RSTXLS.AddParToHeader( <name>, <value> ) 

- Set request body with given content

RSTXLS.SetRequest( <request_body> )

- Perform given HTTP request using the previously set parameters:

RSTXLS.RestPost\\
if ErrorCode > 0 then\\
# necessary error handling. Standard HTTP errors are reraised with +1000. I.e. HTTP error 404 will be raised as 1404.\\
endif\\

- Retrieve response from HTTP call

$response = RSTXLS.GetResponse

If the format is JSON, then the following call is valid to start working with JSON:

$handle = TDJsonInit( RSTXLS.GetResponse )

Contains content of request.

To set request - use method SetRequest

Contains content of response.

To get response - use method GetResponse

URL for REST base endpoint

Maximum size 2048

To add nodes to URL - use AddToURL To add parameters to URL - use AddParToURL To get full URL - use GetURI

Includes parameters of URL

To add parameter - use function AddParToUrl

Contains current URL.

To get current URL - use GetURI

Indicates parent module of current instance of RSTMOD. Used as security sontext

Contains header for the request.

To set header - see method AddParToHeader

When set to non-empty - debug info after API call can be found in stream DBGSTM and saved in debug folder

For the folder - see function SYSTDC.GetVerboseFolder

When set to non-empty - request of API call is saved to debug folder.

For the folder - see function SYSTDC.GetVerboseFolder

When set to non-empty - response of API call is saved to debug folder.

For the folder - see function SYSTDC.GetVerboseFolder

PCH-717 Contains header for the response.

To get header parameter - see method GetHttpHeaderParameter

Contains content of http response body

PCH-717 Contains content of http response header

This method returns content of response from the previous HTTP call

Returns complete URI of the endpoint including all parameters and added nodes

Adds pair “ArgPar”: “ArgValue” to the header of REST call

ArgPar - name of parameter
ArgValue - value of the parameter

Adds parameter + value to URL for REST API calling

Corresponding functions: RestGet, RestPost, RestPut, RestDelete, AddToURL

Adds node to URL

Corresponding functions: RestGet, RestPost, RestPut, RestDelete, AddParToURL

Initialize instance of RSTMOD with statically defined settings

Settings are stored in AppIniFile under section named as instance of RSTMOD

Initialize RSTMOD with given URL

Calls for REST DELETE method
Errorcode must be checked afterwards
Result can be retrieved by method GetResponse

Corresponding functions: RestGet, RestPost, AddToURL, AddParToURL

Calls for REST GET method
Errorcode must be checked afterwards
Result can be retrieved by method GetResponse

Corresponding functions: RestPost, RestDelete AddToURL, AddParToURL

Calls for REST POST method
Errorcode must be checked afterwards
Result can be retrieved by method GetResponse

Corresponding functions: RestGet, AddToURL, AddParToURL

Calls for REST PUT method
Errorcode must be checked afterwards
Result can be retrieved by method GetResponse

Corresponding functions: RestGet, RestPost, AddToURL, AddParToURL

This method is used to set request for the upcoming HTTP call

ArgReq - content of request to be sent

Resets fields of RSTMOD to the state of initialization (without clearing the settings)
Might be useful in settings transactions to use settings not from ini-file but from current “online” settings

returns the value of the response http header parameter ArgPar

ArgPar: name of http header parameter

returns: value of http header parameter

This method returns the content of the functional body (payload data) of the response from the previous HTTP call
It strips away from the response all technical headers (control data)