API CATALOG

Access to APIs

Our API CATALOG gives you access to a variety of APIs that can be filtered the way you see fit.
The APIs are organized by categories.
The categories are:

  • Core Data
  • Task
  • Liquidity
  • Payments
  • Working Capital

Once you have found the API of your interest, you need to be registered to access its Details.


Upon your completed registration you will be provided with more information about the selected API, helpful diagrams, and use cases.
At this point you can access Details


However, to be able to view an API definition, you need to contact Kyriba for the permission.


You create a Ticket in SUPPORT, (category Kyriba APIs).

Upon receiving the permission, proceed by clicking View APIs button.


API Details

In the images below we provide the explanation for each API object.

For the convenience of your reading, the whole image is divided into two parts.

Part one:



Object Name Comment Image Item
Title API's title.       1
Version API's Version number.       2
Category Core Data
Task
Liquidity
Payments
Working Capital
      3
Short Description API's short description.       4
View APIs Possibility to:
View the API definition
Download Open API Spec
Download Postman Collection
Look at its Changelog
      5
Catalog Image API's Logo image.       6
Long Description API's detailed description.       7


Part two:



Object Name Comment Image Item
Description Image An Image that describes relationship between the main entities.       8
Use Cases Relevant Use Cases.       9