The API is documented with the Swagger framework, where focus is on creating an API that is available for test, and usage, right after you have gained access. This document, and in combiniation with the swagger framework should promote a shortend learningcurve.
Lets kick this off by aligning some general terms of the API:
- The terms are business driven - that is terms that non-technical person should understand.
- The API is versioned with a versionnumber is attached to the root URL. Noted as a post fix notation https://api.farpay.io/
- All endpoints are authenticated with an API key. See how to get an API key
- All endpoints have an
HTTP_GETmethod, that return a collection of the corresponding object, or in some cases, a reference-object, which is a minimum presentation of a larger business object.
- All endpoints have a sub-child HTTP_GET method, that returns a single object, that is further elaborated in details and relations. One example is the invoice. The invoice is grabbed from the
https://api.farpay.io/invoices/<invoice ID>, where the
<invoice ID>identifies that specific invoice.
- All endpoints are testable in the swagger UI, by entering the API-Key or by adding the request headers.
- Date is rendered in two formats. The input date is given as
yyyy-MM-dd, while a date result is rendered as
- Other endpoints depending the http-verb, such as
DELETE, depending on the available functional scope. Furher info on these, where you dive in.
The url is
After the Url, You have to determine the version. Current version is
Table of objects
Each object is described in this hub, and available from our testable Swagger API
This document focuses on explaining of how the developer can get started by testing with an API-Key, and by testing, see how the API works and how it is used by staging simple examples to
The swagger document is available from:
The first version of the api is now legacy.
You are welcome to try FarPay for free, by applying on our webpage. Afterwards, you are welcomed to apply for an API-Key by sending a request in our chat.
Now the all the general stuff has been aligned, let's go into the details. View this document of how to get started, and the swagger document as the detailed document of how the endpoints are reached.
Since users of the API are business users or enterprise users, they get an extra access to your support-and-ticket system, where issue, needs and wants can be described or raised.