Getting Started

Getting Started with Postman

Overview

This guide provides you with all the necessary information structured into the simple steps, so that you can perform your first API request with Postman on our Kyriba API Playground.

Please refer to the video below to learn how to:

1. Create a support ticket to request access to our APIs.

2. Download a collection from Postman.

3. Import a collection.

4. Run your first request.

1. Create a Support Ticket to Request Access to our APIs

To request API credentials, you should create a Support ticket on the Developer Portal.

Please refer to the example below:

Next, after the review by the Kyriba team, you will receive your credentials (client_id / client_secret) within 2 business days.

2. Download a Collection from Postman

To start testing, you can either use the Online version of Postman or download the Postman Desktop application.

Note❗ Online version has a restriction of 1K API calls per user (monthly).

If you have already received your API credentials, you can verify their validity by following the steps presented in the Test your Credentials guide, or you can use a Postman collection we have created for you. Just click on the Download Postman collection.

Once you are signed in to Postman, proceed by selecting one of your workspaces or create a workspace from scratch, if necessary.

3. Import a Collection

Your next step is to click Import and then Upload Files, which you have previously downloaded from the API Catalog.

This will create your API collection in Postman.

In it, you select the Get Token request.

Then, proceed to the Authorization tab and make sure it is set to the Basic Auth type. Replace Username and Password with the corresponding client_id / client_secret that Kyriba has provided to you upon your request.

Next, in the Body tab, make sure to set grant_type.

Finally, you click on Send and then you receive an Access token. The generated token will be automatically stored in your collection.

4. Run Your First Request

Now, you are authorized to interact with your API and start testing it.

You go to List accounts.

You click Send.
You receive the requested Accounts.

Congratulations! You have successfully performed your first Kyriba API request with Postman.

Note❗ If you received an Error message as a result of your call, please refer to the HTTP Status Codes (access requires registration) guide for explanation.

Generate a Code Snippet in Postman

In order to perform a request in your favorite programming language or framework, generate a code snippet.

Click Code icon on the right panel to open the Code snippet tab.

Here, you can access the language you want, to correspond the call you have made with Postman.

For more information on code snippets generation, supported languages and frameworks, click Generating client code page.

Getting Started With CaaS ERP

Below are the steps to start the CaaS ERP subscription, along with information on downloading related packages and documentation.

1. Register on the Kyriba Developer Portal

New customers should register on the Developer Portal to access the ERP Forums and their resources:

• ERP Client Credentials Requests (applicable to Dynamics 365 Finance and Oracle Financials Cloud).

Note❗ To learn how to create credentials for the connectors other than Dynamics 365 Finance and Oracle Financials Cloud, please refer to the Customer Onboarding guide. Additionally, contact the ERP team to learn if a certain connector requires a credentials request or can be achieved via Self Service.

• Installation and User Guides.

• Package Releases.

Next, you need to subscribe to notifications to receive updates.

2. Request Access to ERP Forums

Customers with active subscriptions to CaaS ERP offerings can request access to the Developer Portal Forum related to their ERP. To do that, please create a Support ticket completing the following information:

3. Subscribe to Notifications

To receive automatic updates about the new releases and updates in the documentation, you need to subscribe to the Forum category and/or to the particular Topic, by clicking the relevant buttons as shown below:

When set, you will receive notifications whenever new Topics are added or updated in the Forum, including packages and documentation updates.

Access and Download Docs and Packages

To access Addon packages and documentation, navigate to Home ⇨ Community ⇨ Forum ⇨ ERP Connectivity.

Locate the specific ERP Forum Topic for your system.

Review the Forum Topics for Addon packages and documentation.

Access and Download Getting Started Guide

The Getting Started guide can be found in the General ERP Topics forum along with a companion document containing references to additional resources.

Download both documents for the most up-to-date information to get your project started.