Abacum APIs
Product · API / developer platform by Abacum
Bring in data from any system and put your Abacum models to work across your business.
Developer-focused REST APIs for integrating Abacum with external systems. They enable businesses to export model data and logic or import data from custom pipelines using secure OAuth 2.0 authentication.
Category: API Management
- APIs and SDKs
- Public API, Import API
- Protocol
- HTTP REST
- Data Format
- JSON
- Authentication
- OAuth 2.0
- Architecture
- Resource-oriented URLs
- Export actuals, scenarios, and working version data from models
- Load data from proprietary systems or internal databases via Import API
- Read model logic programmatically to verify calculations
- Unified OAuth 2.0 authentication for both Public and Import APIs
- Downloadable OpenAPI specification for faster development
Overview
Abacum APIs are a suite of developer tools designed to integrate the Abacum business planning platform with external systems and internal databases. The offering is divided into two primary products: the Public API for exporting plans, actuals, and model logic, and the Import API for loading data from systems without native integrations. These HTTP REST APIs allow businesses to automate data flows, ensuring that proprietary data pipelines can be part of a unified planning process. Developers can access both APIs using a single set of OAuth 2.0 credentials and a unified host at api.abacum.io. By providing programmatic access to datasets and model logic, Abacum APIs enable teams to put their financial models to work across the entire organization.
Public API Capabilities
- Model Data Export: The Public API allows developers to export actuals, scenario data, and working version data directly from Abacum models.
- Dataset and Table Access: Users can export raw or processed datasets and tables created within Abacum Spaces for use in external systems.
- Logic Inspection: The API provides programmatic access to read model logic, allowing teams to see how specific numbers are calculated.
Import API Capabilities
- Custom Data Loading: The Import API enables loading data from proprietary systems, internal databases, or custom pipelines into Abacum datasets.
- Unified Processing Pipeline: Imported data is processed using the same pipeline as native integrations, ensuring consistency across data sources.
- Pipeline Control: Developers have full control over when and how external data reaches the Abacum planning environment.
- Scheduled Imports: Data imports can be configured to run on any schedule chosen by the organization.
Developer Experience
- RESTful Architecture Engagement: Both the Public and Import APIs are built as HTTP REST APIs with resource-oriented URLs.
- JSON Responses: The APIs use JSON for all responses, providing a predictable format for integration.
- Unified Authentication: A single set of OAuth 2.0 credentials and one host provide access to both the Public and Import API products.
- OpenAPI Support: Developers can download an OpenAPI specification to facilitate client building and integration testing.
Use cases
- Data teams export actuals and scenario data from Abacum models to use in external reporting tools.
- Developers load data from a proprietary internal database into Abacum datasets when no native integration is available.
- Finance analysts programmatically read model logic to audit and verify how specific numbers are calculated within the platform.
- Engineering teams build custom data pipelines that automatically send data to Abacum on a specific schedule.
Specifications
- APIs and SDKs
- Public API, Import API
- Protocol
- HTTP REST
- Data Format
- JSON
- Authentication
- OAuth 2.0
- Architecture
- Resource-oriented URLs
How it works
- Get credentials: Users generate a client ID and a client secret within the Abacum application to begin the integration process.
- Authenticate: The client credentials are exchanged for an OAuth 2.0 access token to authorize API requests.
- Make your first call: Developers make their first call to the API using the access token and can download the OpenAPI specification for reference.
FAQ
What is the difference between the Public API and the Import API?
The Public API is used to export plans, actuals, datasets, and Space tables, as well as to read the logic behind models. The Import API is used to load data from systems that have no native integration.
How do I get access to the Abacum APIs?
To enable either the Public API or the Import API, you must contact your Abacum Customer Success Manager. Each product is enabled separately for an organization.
When should I use the Import API instead of a native integration?
You should use the Import API when no native integration exists for your data source, such as a proprietary system, an internal database, or a custom data pipeline.
What authentication method do the Abacum APIs use?
Both APIs use a single host and are authenticated using OAuth 2.0. You generate a client ID and client secret within the Abacum app to exchange for an access token.
Added by AntSpace from public sources (developer.abacum.ai).