Functionality
Import
The API includes the following functionality:
-
Import the following:
-
Core loss data
-
Interval tables that allows the geotechnical and geological products to be calculated over customer’s specified intervals.
-
Note that image import is not yet available.
Export
-
Export the data generated by each product as described in each of the Product Descriptions.
Note that image export is not yet available.
How we handle authentication
Our API uses a public-private key pair authentication system specifically optimised for server-to-server integrations like yours, delivering several key advantages.
Our system utilises strong encryption and digital signatures, the same security standards employed in financial and government systems. This provides:
- Complete key ownership: Your private key remains exclusively in your environment and under your control
- High performance: Low latency authentication without token exchange overhead, ideal for high-volume API traffic
- Strong security: Each request includes a unique digital fingerprint and timestamp verification to prevent tampering
- Stateless verification: No session tokens to manage, simplifying your integration
- Simple key rotation: When needed, you can easily rotate keys through our UI
- Comprehensive logging: All API activities are recorded for audit purposes
This authentication method is particularly well-suited for enterprise integrations requiring both security and performance.
For detailed instructions on API registration and authentication setup, see our API Registration Guide.
API Documentation
Detailed API documentation for developers can found found here:
Document Version
|
Version |
Date |
Author |
Rationale |
|---|---|---|---|
|
1 |
22 August 2023 |
S Johnson |
Initial release |
|
2 |
20 October 2023 |
S Johnson |
Include Export API |
|
3 |
16 August 2025 |
S Johnson |
Include additional products |