Use the Integration feature to create RESTful Application Programming Interfaces (APIs). An integration is a real-time connection between your application and an Irth system.
APIs use methods to load data from multiple apps. You can choose the methods that apply to each form.
For details on how to create APIs, see the API doc: https://www.irth.com/irthnet/docs/api CL: https://cl.irth.com/irthnet/docs/api
You can also manually load data from Microsoft Excel or CSV files into apps. See Data Sources.
Integration Summary
Integrations are displayed in a list on the Integration Summary page
To see an integration, in the Integration Name column, click the integration you want to edit
Function | Description |
Create New Integration | In the upper right corner, click Create New Integration. Go to Create Integration, step 3, below |
Documentation for API Integration | In the API Key column, click API Documentation. Methods vary depending on how you set up the Integration |
Edit Integration | In the Integration Name column, click the Integration Name |
View History of Changes |
You can also view the History from an individual integration (in the upper right corner) |
Create Integration
- On the top menu bar, click System Management ( )>Administration>Work Management>Integration Configuration
- On the Integration Summary page, in the upper-left corner, click Create New Integration
- On the Create Integration window, fill in the Integration Name. Click Continue. Go to Modify Integration, step 3, below
Modify Integration
- On the top menu bar, click System Management ( )>Administration>Work Management>Integration Configuration
- On the Integration Summary page, in the Integration Name column, click the integration you want to edit
On the Integration page, locate the forms and make changes as below:
3a: GeneralAPI Key
You can create a new API key:
Action Description Reset API Key The API key is generated by the system. Click Reset API Key to generate a new key. If you change the key, you must use the new key in your form or integration will not work
General Actions/Methods
Choose the API methods you need. By default, all actions/methods are enabled
To change methods:
Number of methods enabled Action All - Click All actions>N
- Go to step 2
Fewer than all - Go to step 2
- Check or uncheck the boxes to choose general actions/methods. All general actions/methods are turned on by default. For details, see the API document (actions are called "methods"): https://www.irth.com/irthnet/docs/api CL: https://cl.irth.com/irthnet/docs/api
3b: FormChoose the forms the API integration applies to.
- In the bottom left corner, click + Add Form
- In the dropdown list, click the form
- Click Add Form.
- The actions/methods vary by form. By default, the actions/methods of the form are turned on. For details, see the API document (actions are called "methods"): https://www.irth.com/irthnet/docs/api CL: https://cl.irth.com/irthnet/docs/api
- You can define multiple criteria for a filter. Click the red X to delete a criterion
- When finished, click Save (Filter Details page appears) or Cancel to discard your changes
Delete Integration
- In the bottom right corner, next to the Cancel button, click the ellipsis (...)
- The Delete button appears.
- Click Delete
View History of Changes
There are two ways to view the history of changes to integrations:
- On either the Integration Summary page or an Integration page, in the upper right corner, click History
In the History window:
Page Description Integration Page The list of all changes and the person who performed them
Integration Summary Page The list of all changes to all integrations and the people who performed them
Click Show Changes to see a description of the change
Alert Configuration
You can use the Alert Notification feature to notified of errors in some API actions/methods. See Alert Notifications
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article