Oliasoft API Reference
Oliasoft´s family of highly performant and capable products are specifically developed to ensure seamless machine-to-machine communication. This allows you to automatically push data into Oliasoft products, pull data from them, or to operate any of the available calculators and simulators.
This guide introduces you to our API capabilities, the end-to-end flow for developing with Oliasoft, and how to start building.
Product APIs
While our products have some overlapping functionality, the products serve very distinct purposes.
| Product APIs | Best suited for... |
|---|---|
  | • Perform "automated" engineering with unlimited scenarios • Build designs programmatically based on data from external sources • Embed powerful calculation capabilities into any internal tool • Generate automated well designs programmatically • Run any calculation in realtime by feeding in new data as you drill |
  | • Automate time and cost projections based on design • Update time and cost forecasts in realtime while drilling • Integrate forecast with third party tools, like digital drilling procedures |
  | • Store and retrieve structured and unstructured well data • Search across multiple data sources • Monitor data and ongoing operations • Trigger warnings with email notification based on data updates • Integrate with internal and external data sources |
Here´s some examples of Oliasoft´s API capabilities and common use cases.
| Data Integration | Programmable Engineering | Real-time Operations |
|---|---|---|
| • Import formation data from geo models • Export designs to drilling systems • Feed KPI dashboards • Link to digital twins • Connect warehouse inventory | • Automate casing design scenarios • Run drilling mechanics simulations • Calculate surge/swab pressures • Analyze transient casing loads • Automated anti-collision | • Update designs with live data • Calculate hydraulics while drilling • Monitor torque and drag • Adjust to actual conditions • Trigger alerts on safety limits |
Explore our Integration Cookbook for practical examples with source code.
Start building with Oliasoft
When you´re ready, start building with Oliasoft API´s
- Follow the Getting Started page to make your first API call
- See the API reference for each product for a list of all available endpoints
- Explore the Oliasoft Cookbook for free example code and inspiration
Oliasoft Open Source Projects
When you are building your own applications or integrations with Oliasoft, you can consider using some of our open source projects for fast and easy functionality. Our projects are tailored for various things typically encountered when building advanced engineering applications, like user interface components, charts and unit handling.
| Open Source Repository | Function |
|---|---|
| Oliasoft Charts | • Nicely formatted charts with a lot of functionality • Zoom, Pan, Drag, Download chart as png • Dynamic legends • Well documented usage and examples with Storybook |
| Oliasoft GUI Components | • All GUI components used in Oliasoft´s products • Full pages, headers, sidebars, cards, accordions, buttons etc • Well documented usage and examples with Storybook |
| Oliasoft Units | • Handling of many different conventions related to numbers used in engineering • Native support for Oliasoft´s built-in unit system |