External Integrations - API and End Points

Softools provides a robust set of APIs that facilitate access to application data and definitions. These APIs, some of which are publicly accessible, enable the integration of Softools with third-party services, enhancing functionality and data utilization. 

• Authentication and Security

• API Documentation and Rate Limits

• Core API Endpoints

• API Call Structure

• API Expansion Requests

Authentication and Security

All calls to the API require authentication. This is achieved via a user-specific API key which can be exposed in 'My Profile', providing the User account has the 'SetApiKeySecret' permission found under the Settings section of Permissions. This ensures consistency with our security model to ensure there is no possibility of data being exposed without authentication.

API Documentation and Rate Limits

Full details on API usage, including authentication headers and endpoint definitions, are available at our developer portal. To safeguard against potential security threats, API calls are subject to throttling as outlined here.

Core API Endpoints

Integrate third-party applications like Power BI to augment Softools apps, enabling bidirectional data flow. APIs empower users to perform various operations:

• GET App Record Data: Fetch data for a specific app.
• PATCH App Record: Update a particular record within an app.
• POST New App Record: Create a new record in an app.
• PATCH Data via CSV: Update records from a CSV file.

Note: The Softools API is designed for fair and sustainable use. Please consult with us regarding any queries about fair use policies.

API Call Structure

A typical API call to Softools includes:

• METHOD: Specifies the action (GET, PATCH, POST).
• URI: The endpoint URL, which begins with https://api.on.softools.net/, followed by the specific path.
• HEADERS: Essential for authentication, including API keys and content type when needed.
• BODY: Required for PATCH and POST methods, usually containing JSON data or base64-encoded file content.

API Expansion Requests

All platform actions are API-driven, offering extensive integration possibilities. To request additional APIs, contact your Account Manager or submit a Feature Request in the Softools Community.