Best practices

The following best practices should be taken into consideration when building an integration using the Oracle Clinical One APIs.

Note:

Multi-threading approach to make API calls should be discussed with services team for optimization.

Action	Description
Pull data incrementally from Clinical One.	Create your integrations with an incremental approach (not cumulative). Oracle Clinical One APIs contain parameters which allow you to specify the from and to date/time to pull data between. This will ensure there aren't any system performance issues and that you are only pulling the most recent data. Tip: Ensure the used timestamps overlap the previous time frames in order to not miss any data.
Limit the amount of APIs used in your integration.	The less API calls that are used in your integration the better the performance will be. Limit the amount of API calls your integration uses so it does not overwhelm the system. This will result in a faster data integration.
Build in a retry mechanism to handle any API failures.	There are certain reasons an Oracle Clinical One API call may fail, such as the system being down. Make sure to include a retry mechanism to re-call the failed API calls and ensure no loss of data in your integration.
Track token expiration.	A token is valid for 10 minutes. If you are working with numerous API calls, make sure to track token expiration at every Oracle Clinical One API call you make. Do this to make sure you are using a valid token or to generate a new one when needed. Tip: You can also generate a new token for every API call to ensure no token expiration.
Consider network timeout of 2 minutes through network hops.	The incoming or outgoing payload should complete within 2 minutes before a network timeout occurs. Monitor your transactions to complete successfully in the specified amount of time or retry if necessary.