Discover our Developer Portal
If You Are a Newcomer
If you are not registered yet, you are still provided with certain options to explore. However, we encourage you to register and to unlock the full range of features and resources to fit your development needs.
Option | Details |
---|---|
Home | Click it to return to the Developer Portal main page. |
Documentation |
Getting Started - provides you with: ◦ "Getting started with Postman" tutorial, with the explanatory video. ◦ "Getting Started with CaaS ERP" tutorial. Overview - provides you with Developer Portal documentation. Webhook Notifications - provides you with the overview of Webhooks concept, as well as the explanatory video. Glossary - provides definitions for the key terms/abbreviations used on the Developer Portal. |
API |
Use Cases - provides you with examples of different Use Cases that correspond to a business need. API Catalog - provides you with a variety of APIs developed by Kyriba, that can be implemented into creative solutions by the consumers. API Changelog - provides you with all news and updates that take place in Kyriba. |
Community |
News and Articles - provides you with Kyriba related articles and news items. Forum - a section where you can find the information you are looking for or initiate your own discussion. Access to Forum requires registration. |
Marketplace | Marketplace - provides you with the application catalog that lists apps developed by Kyriba and verified third-parties. |
Contact Us | Contact Us, if you have any issues with registration or logging in or about any other occurring issue. |
If You Are Registered
After you have registered and created your account, you gain much more options to explore:
Option | Details |
---|---|
Home | Click it to return to Developer Portal main page. |
Documentation |
Getting Started - provides you with: ◦ "Getting started with Postman" tutorial, with the explanatory video. ◦ "Getting Started with CaaS ERP" tutorial. Overview - provides you with the basic Developer Portal documentation. Webhook Notifications - provides you with the overview of Webhooks concept, as well as the explanatory video. Guides - provides you with information about API Reference, Authorization for Kyriba APIs, App Studio Implementation, Bank API: Set-up Guide (accessible for customers and official Kyriba's partners only), Best Practices, Customer Onboarding (accessible for verified Kyriba Customers only), HTTP Status Codes, Open Reports Studio, Payment Service Provider Integration, Troubleshooting Guide, Webhook Notifications, and Working with Tasks APIs. Sample Tutorials - provides you with the guide on how to build Basic Apps and Sample Apps from scratch. Glossary - provides you with definitions for the key terms/abbreviations used on the Developer Portal. |
API |
Use Cases - a section that gathers examples of different Use Cases that correspond to a business need. API Catalog - a section that gives you access to a variety of APIs developed by Kyriba, that can be implemented into creative solutions by the consumers. API Changelog - a section that tracks all news and updates that take place in Kyriba. |
Community |
News and Articles - a section that presents Kyriba related articles and news items. Forum - a section where you can find the information you are looking for or initiate your own discussion. |
Marketplace | Marketplace - you can access our application catalog that lists Apps developed by Kyriba and verified third-parties. |
OPEN FORMATS STUDIO |
Open Formats Studio page covers the information about the following tools: Formats Translation Tool / Bank File Postprocessing Tool / Comparison Tool Alias Library / Alias Statistics Open Formats Studio requires special access. |
Support | If any issue occurs, you can create Support Ticket. |
Once Your Registration Is Complete
In the top right corner of the page you can access Search, Developer Portal Notifications and User icons:
Please refer to the following sections below for more information.
Developer Portal Search
Comment | Details | |
---|---|---|
If you look for something | Click the Search icon. |
Enter the information you look for in the search field. |
If you need more information | Use the Advanced Search. |
You can search with: ◦ Key words ◦ Exact phrase ◦ Conditional Search (using AND, OR, NOT, etc.) ◦ Time frame (Start Date / End Date) |
Developer Portal Notifications
Please refer to Developer Portal Notifications section to gain full information about notifications, their types and their subscription management.
User
By сlicking on your Username icon, you can access the following:
Description | Details | |
---|---|---|
My Profile | You can: ◦ Edit your profile information. ◦ Download your data. ◦ Disassociate from your Company. ◦ Subscribe to Notifications via Email by checking the box. ◦ Update Your Password. Please mind, you cannot edit your Forum Username. |
|
View My Company | You can see details about the Company that you Associated with. |
|
My Dashboard | You can manage both your Contact Us Tickets and Support Tickets. For more information click My Dashboard page. |
|
Logout | You click it to exit the site. |