Getting Started

Authentication

All endpoints require authentication by using an ApiKey or Bearer Token.

API access is available upon agreement. Contact your administrator or Oliasoft Customer Success team for help.

Content Types

Oliasoft APIs always accepts JSON in request bodies and returns JSON in response bodies. You will need to send the content-type: application/json header in requests.

Once you have this set up, you are good to go. Consider using some of the following resources to get started:

Resource	Details
List designs endpoint	Simple endpoint to get a list of available designs
Download Postman Collection	Postman Collection containing all Oliasoft endpoints with example queries
Integration Cookbook	Great resource of practical integrations with example code

Procedure for integrations

If you wish to build integrations to Oliasoft products, you must follow the following process:

Integration procedure

1. Request an API key for one or multiple products
2. Build your integration using defined endpoints on the QA environment.
   Base URL https://{product_name}.qa.oliasoft.com
3. When integration is complete - contact Oliasoft for integration review
4. If / when approved, integration can be hooked up to production environment.
   Base URL https://{product_name}.oliasoft.com You will need a new API key for authenticating to production.

product_name can be: welldesign , forecast , archives