GLOSSARY ![]()
This section provides clear and concise definitions for the key terms and abbreviations used on the Developer Portal. It is designed to help users understand the meaning of the words and phrases used throughout the website.
A
Access Profile
➤ A list of functions that can be accessed by users. For each function the access can be opened / closed for each individual action.
Access Token
➤ A string that contains security credentials used by an application to make API requests on behalf of a user. It represents the authorization of a specific application to access particular resources.
Alias
➤ Alias is a keyword that triggers a specific rule and generate different output file in Open Formats Studio tool. Alias combination defines the set of rules to be applied to the Format that is not part of the standard. It is what allows customization of the output file.
API Changelog
➤ API Changelog tracks all news and updates that take place in Kyriba.
Example: added new API / endpoint / version, published new article, released new App, etc.
API Environment (type)
➤ Sandbox
API Gateway
➤ An API management tool that sits between a client and a collection of backend services. An API gateway acts as a reverse proxy to accept all API calls, aggregate the various services required to fulfill them, and return the appropriate result.
The Kyriba API Gateway is the entry point for any Kyriba customer applications to communicate with any Kyriba functional components providing APIs.
API Platform
➤ An environment that provides a runtime execution context for APIs. An API revision must be deployed to an environment before it can be accessed at runtime.
Kyriba platforms are:
- sapphire
- ruby
- opal
- emerald
- diamond
- topaz
API Specification
➤ A document or standard that provides a broad understanding of how an API behaves and how it links with other APIs. It explains how the API functions and the results to expect when using the API, it describes API objects, values and parameters, how the objects are called, and what each object does. We also see the relationships between the objects and how each object can be used.
See more in OpenAPI specification.
API
➤ An API stands for Application Programming Interface. In the context, the word application refers to any software with a distinct function. Interface can be explained as a contract of service between two applications. This contract defines how the two communicate with each other using requests and responses. Their API documentation contains information on how developers should structure those requests and responses. In Kyriba we are exposing openAPIs.
B
Base URL
➤ An address that contains the host name or domain name that allows you to access an API. The resource or endpoint paths and query parameters are appended to it to reach the resource.
Example: {{baseUrl}}/v1/account-groups, where baseUrl is https://demo.kyriba.com/gateway/api
C
Client Credentials
➤ OAuth2 grant type that is used to get a token when clients request an access token to access their own resources. The API Gateway validates a pair of client_id / client_secret and responds with an access token. The application uses the access token to call an API.
Customer
➤ A Kyriba customer is a company that purchases services offered by the Kyriba Application.
For Developer: The Customer Code is entered in the login box. The Customer Code is also referred to as Client Base. A Customer can have several users.
D
Data Permission
➤ A Kyriba function that allows to filter what data can be seen and used by a user and is defined per data type.
Data Permission Profile
➤ A combination (can be one or more) of Data Permissions to be assigned to a user that may be of distinct Data types. It can be assigned to one or more Kyriba users (but is optional, as opposed to the Access Profile that is mandatory to create the user). A Data Permission Profile is dynamically updated and can be defined as General or / and By function.
Developer Portal Notification
➤ A notification that you receive via email, regarding the information items that you have subscribed to on the Developer Portal.
More information can be found in Notifications page.
E
Endpoint
➤ An endpoint is one end of a communication channel. When an API interacts with another system, the touchpoints of this communication are considered endpoints. It is basically a URL of a server or service.
Example: https://opal-sandbox.treasury-factory.com/gateway/api/v1/companies, where the endpoint is /v1/companies.
Event
➤ An action that occurs in the customer’s database such as creation, modification, deletion, and completion of process execution, etc.
A list of available Events can be found in Webhook Notifications guide.
Expires_in
➤ A parameter that defines the lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated. By default, the value is 3600 seconds (1 hour).
F
Forums
➤ Forums is a Developer Portal community, that contains various categories of discussions, topics, frequently asked questions, announcements and other useful information. This is the space where you can ask questions, as well as share your ideas with others.
More information can be found in Forums page.
G
Generic User
➤ A generic user is the one who has registered not under a corporate email address, but under a generic one, like Hotmail, Gmail, etc. In this case, this user will be automatically assigned to the "Generic Users Company" and you will not have access to the API Documentation.
Google Colab
➤ "Colab" or Colaboratory is a product that allows you to write and execute Python in your browser, with zero configuration required. It is a hosted Jupyter notebook service that requires no setup to use, while providing access free of charge to computing resources including GPUs.
Feel free to discover our Google Colaboratory Sample Tutorials we have created for you.
Guide
➤ Developer Portal guides provide you with the detailed step by step instructions and flow of actions for productive work with Kyriba APIs, and for the further integration of the retrieved information into your application.
Feel free to discover our Developer Portal Guides section.
K
kapp_username
➤ A parameter that identifies the Kyriba Application user to whom the token is linked. It contains both customer and user codes separated by @ such as the following: customer_code@user_code.
Kyriba API Playground
➤ A dedicated testing environment provided by Kyriba, where developers can experiment on our APIs, but with certain limitations.
M
Marketplace
➤ It is an application catalog that lists Apps developed by Kyriba and verified third-parties. It is aimed at those producers who want to introduce their creative solutions leveraging Kyriba functionality, as well as at consumers who will benefit from it.
More information can be found in Marketplace page.
mTLS
➤ mTLS stands for mutual TLS and consists of having the API server also checking the client certificate.
More information can be found in mTLS section.
N
Notification
➤ An alert to notify the user of certain changes that have occurred, in regards to what the user had subscribed to. For example, Developer Portal Notification, or Webhook notification.
O
OAuth2
➤ OAuth 2.0 is an authorization protocol that validates API credentials of a user. Kyriba uses Client Credentials grant flow, which means the API Gateway validates a pair of client_id / client_secret and responds with an Access Token.
OpenAPI Specification
➤ Provides standard, language-agnostic interface to RESTful APIs in both a human and machine-readable format. It focuses on defining the API and outlining its structure. It can be used to generate API documentation, code samples, and SDKs automatically. It allows a consumer to understand and interact with the remote service with a minimal amount of implementation logic.
Open Formats Studio
➤ Open Formats Studio is a Sandbox environment for the Kyriba Formats Library testing. It allows any format to become customizable. It provides a set of tools that allows to explore Formats Library and find the correct format configuration easily with:
- Formats Translation Tool / Bank File Postprocessing Tool / Comparison Tool
- Alias Library / Alias Statistics
Note❗ Open Formats Studio requires special access. More information can be found in Open Formats Studio page.
P
Process Templates
➤ Process Templates are Kyriba’s feature that allows to import data, launch reports or trigger workflows. They are set up in Kyriba Application by Kyriba users applying different criteria and accesses. Process Templates can be launched via APIs as well as through the UI or sFTP.
Production
➤ An environment of a platform where a product has been publicly released and actually available for business use.
Product Subscription
➤ A self-service function that allows customers to manage licenses (Kyriba modules) assigned to users.
R
Retry
➤ An attempt to deliver an event via webhook.
More information about Retries can be found in Webhook Notifications guide.
REST
➤ REST stands for REpresentational State Transfer. It is a defined set of standards for transferring resources over the web. The REST method is commonly applied to APIs ("REST APIs"), which allow developers to access data from remote systems over the Internet.
REST API
➤ A RESTful API is an architectural style for an application program interface (API) that uses HTTP requests to access and use data. REST APIs have emerged as a common method for connecting components and applications in a microservice architecture.
S
Sample (Sample Application)
➤ A tutorial on Developer Portal that teaches you how to create, build and run your own application from scratch.
Feel free to discover our Sample Tutorials we have created for you.
Sandbox
➤ An environment of a platform that testers can use to replicate the characteristics of the production environment without actually impacting it.
Scope
➤ A list of endpoints which the user has the right to access.
Service Token
➤ An identifier provided by Kyriba to allow users access the Kyriba Modules. The Service Tokens are determined by the a set of features in modules to which the company has subscribed. Progressively is being replaced by Product Subscription.
T
Token URL
➤ A URL that contains an authentication token valid for a specific time and / or a number of usages and grants access to a connection profile.
Example: https://demo.kyriba.com/gateway/oauth/token
TLS
➤ TLS stands for Transport Layer Security and is an adopted security protocol designed to facilitate privacy and data security for communications over the Internet. In Kyriba it is used to secure the connection between the API client and the API server by validating the Kyriba’s server certificate.
U
Use Case
➤ A scenario corresponding to a business need. It is composed of different actions or steps that define interactions between APIs and the system to achieve a specific goal or result.
More information can be found in Use Cases documentation.
User
➤ A user is defined by a unique code, an Access Profile, a Service Token or Product Subscription configuration (depending on database type) and a Data Permission Profile (optional).
- Code will be used when logging in Kyriba application (along the customer code and the password).
- Access Profile determines which functions and actions a user can access. Note: the application of the selected Access Profile is not immediate. It is only effective the next time the user logs in the application.
- Service Token determines which Modules a user can access. The available Service Tokens depend on which Services your company is subscribed to.
- Product Subscription determines which Modules a user can access. It is managed by customers directly.
- Data Permission Profile determines which entities (Companies, Accounts, Transaction codes, etc.) a user can access.
W
Webhook
➤ An HTTP request triggered by an event and sent to the preconfigured customer’s URL.
Additional information can be found in Webhook Notifications guide.
Webhook Notification
➤ A push message represented as “application/json” documents (sent via POST request) delivered via Webhook, that is triggered by an event happening in the Kyriba Application.
More information can be found in Webhook Notifications guide.