As an API

In some cases, using an API for sending and receiving data as a microservice may be more efficient. To address this, we have developed a lightweight REST API that allows for sending POST requests and receiving JSON responses

Usage¶

Just make sure to send your POST data in the proper format.

curl -d "@data.json" -H 'Content-Type: application/json' -X POST http://localhost:3000/api

where data.json looks like the below:

{
 "data": {...}
 "method": "pxf2bff"
}

Interactive API specification

Please find here interactive documentation (built with ReDoc).

Included APIs¶

We included two flavours of the same API, one in Perl and another in Python.Both APIs were created by using OpenAPI 3.0.2 schema and should work out of the box with the containerized version.

Local or remote installation?

The API should be installed on a local server.

Perl versionPython version

Please see more detailed instructions at this README.