Entry point for the external API
The configuration object for the request. Used by the other helpers, but available to use directly giving the most flexibility.
The callback function to call when the request is finished and the response is available.
Helper to perform a get request to the external API. Allows to simply set the query parameters as a record of key value pairs.
The name of the external api source.
The name of the external api action.
The query parameters to use.
The callback function to call when the request is finished and the response is available.
Helper to perform a post request to the external API via a form post. Allows to pass in the form dictionary which will be used for the body of hte request.
The name of the external api source.
The name of the external api action.
The body as a form dictionary.
The callback function to call when the request is finished and the response is available.
Helper to perform a post request in JSON format to the external API. Allows to pass in the body as a dictionary which will be serialized to JSON.
The name of the external api source.
The name of the external api action.
The body as a dictionary - which will be serialized to JSON.
The callback function to call when the request is finished and the response is available.
Heler to perform a post request in raw format to the external API. The data has to be seriaized already.
The name of the external api source.
The name of the external api action.
The body to send.
The callback function to call when the request is finished and the response is available.
Generated using TypeDoc
The external API interface gives access to trigger the configured and available external API's.