Loading...
Searching...
No Matches
BillwerkRestClient Module

# BillwerkRestClient Introduction

The BillwerkRestClient module provides an API for calling REST services with the billwerk.com billing / payment platform system.

To use this module, use `"%requires BillwerkRestClient"` in your code.

All the public symbols in the module are defined in the BillwerkRestClient namespace.

The main classes are:

- BillwerkRestClient: this class provides the REST client API for communuication with the billwerk.com REST API; it also automates authentication and authorization
- BillwerkRestConnection: provides a REST connection object to the billwerk.com server (based on the ConnectionProvider module)

Example:
  #!/usr/bin/env qore
  %new-style
  %strict-args
  %require-types
  %enable-all-warnings
  %requires BillwerkRestClient
  BillwerkRestClient billwerk(
  {
  "url": "https://name:pass@app.billwerk.com",
  "client_secret": "8df3cc8be92d300edb9ff9b9a680d22eacbf2ee5",
  "swagger": swagger_path,
  });
  hash<auto> action_data = {
  "name": "Action name 1",
  "description": "description",
  "effort": 48,
  "actionnum": 7771,
  "status": 0,
  };
  hash<auto> response = billwerk.put("/api/v1/actionsteps", action_data, NOTHING, NOTHING);
  printf("Response body: %N\n", response.body);

# Release Notes

## BillwerkRestClient v1.1

- implemented support for a data provider scheme cache and rich option information for connections (issue 4025)

## BillwerkRestClient v1.0

- the initial version of the BillwerkRestClient module