Kuali rest APIs allows you to connect to external data sources including other Classic Kuali products like Kuali Financials (KFS). This article goes over how to set up these integrations with some examples to get you started.
- Kuali Financials API Resources
- Some Examples of Kuali Financials Integrations
- Get a list of Accounts (with associated information)
- Get a List of Higher Education Functions
Kuali Financials API Resources
Information on how to utilize the rest APIs in Kuali Financials is covered in our API Documentation. This gives you an overview of the API process (including getting an API key setup for authorization) and the documentation for the available rest APIs for each Kuali Financials module.
Some Examples of Kuali Financials Integrations
Below are some examples of commonly used APIs to pull information from Kuali Financials to Kuali Platform. This should get you started on how to utilize the APIs in general and expand on other integrations you may want to set up. But if you'd like any other examples added just let us know!
Get a list of Accounts (with associated information)
You can create a lookup in a Kuali form to list Accounts from Kuali Financials and based on the selection then display associated account information.
- Create a new integration in Kuali Platform pointing to the URL below with your specific domain replacing the
{domain}:https://{{domain}}.kuali.co/fin/api/business-objects/accountWhen creating the GET integration (Get List of Data Items) in Kuali you would set it up the fields as outlined below. Specifically the ID Key and Label Key; all else can be left blank (inputing your own unique domain URL and API auth information). You will also likely want to add Outputs in the integration so they can display in the form via the 'Add linked auto-filled gadgets' option in the gadget; then drag into the form.
You can click run test to see the results in the top left section when you select an Account from the dropdown. Then click save to save the integration.
- Add a new Advanced gadget of Data Lookup (List) and for the Data Source point it to the newly created integration via External. Also, click Add linked auto-filled gadgets to access the output fields so you can drag them into the form:
Once added to the form, it will look like this as a selectable dropdown populated by Accounts pulled from Kuali Financials:
Get a List of Higher Education Functions
You can retrieve a list of any table values so this premise could be applied to any desired values out of Kuali Financials. In this example, maybe you want to create a dropdown in a Kuali form based on the Higher Education Functions in Kuali Financials.
- Create a new integration in Kuali pointing to the URL below with your specific domain replacing the
{domain}:https://{{domain}}.kuali.co/fin/api/business-objects/HigherEducationFunction
- When creating the GET integration (Get List of Data Items) in Kuali you would set it up the fields as outlined below. Specifically the ID Key and Label Key; all else can be left blank (inputting your own unique domain URL and API auth information):
You can then click Run Test to see the results of the Higher Ed Function dropdown and then click save.
You could add other information as Outputs in the integration (if they exist) to then display in the form as desired via the Add linked auto-filled gadgets option in the gadget; then drag into the form.
- Add a new Advanced gadget of Data Lookup (List) and for the Data Source point it to the newly created integration via External:
As mentioned above if you have Outputs in the integration you can then utilize them via the Add linked auto-filled gadgets by dragging them over into the form to the desired location.
Once added to a form, it will look like this as a selectable dropdown populated by Higher Education Function Codes pulled from Kuali Financials:
Comments
0 comments
Article is closed for comments.