Learn how to securely connect Acadimiat to the Business API using API keys and OAuth tokens, with recommended scopes to control access.
Acadimiat authenticates to the Business API via a client credential flow and scoped access; follow these steps to obtain credentials and set up secure connections.
1) GET /businesses — list businesses 2) GET /businesses/{businessId} — retrieve a specific business 3) POST /businesses — create a new business 4) PUT /businesses/{businessId} — update a business 5) DELETE /businesses/{businessId} — remove a business
Trigger: A new or updated business is created in Acadimiat, initiating a sync to the Business API.
Actions: POST /businesses to create a new record, PUT /businesses/{businessId} to update; map fields such as name, address, industry.
POST, PUT
Key fields: businessId, name, address, industry
Trigger: Scheduled interval (daily/hourly) to pull data for dashboards.
Actions: GET /businesses and GET /businesses/{businessId} to fetch data for reports.
GET
Key field: businessId
Trigger: Nightly export of all businesses for analytics.
Actions: GET /businesses to fetch all records and export to CSV/JSON for analytics pipelines.
GET
Key field: businessId
Automate data flows between Acadimiat and the Business API without writing code.
Reduce manual errors by centralizing data sync in one reliable connection.
Scale operations with simple triggers and actions that suit growing needs.
Elements and processes: endpoints, triggers, actions, and data mapping used to connect Acadimiat with the Business API.
Application Programming Interface: a defined set of rules that allows software to talk to each other securely.
A specific URL in an API that performs a defined action or returns data.
A token-based authentication protocol used to securely access APIs.
Permissions attached to an API token that limit access to resources.
Trigger a creation of a matching business in the Business API when a new customer is onboarded in Acadimiat to reduce manual data entry.
Push status changes from Acadimiat to the Business API so dashboards stay current.
Schedule automated exports of all businesses for analytics and reporting.
Obtain client credentials (client ID and secret) for Acadimiat.
Choose scopes like businesses.readonly to control access.
Test authentication, endpoints, and data mappings before going live.
You can retrieve a list of businesses using GET /businesses and fetch details with GET /businesses/{businessId}. For creation and updates, use POST /businesses and PUT /businesses/{businessId} respectively. This enables robust syncing between Acadimiat and the Business API.
No heavy coding is required thanks to no-code connectors, but some basic configuration to map fields and test endpoints will help ensure a smooth setup.
Authentication supports API keys and OAuth tokens. Store tokens securely, rotate credentials regularly, and apply the principle of least privilege by using scoped access.
Best practice endpoints for syncing are GET /businesses for lists, GET /businesses/{businessId} for details, POST /businesses to create, and PUT /businesses/{businessId} to update.
Yes. You can schedule automatic exports to run nightly or at custom intervals, then deliver the files to your analytics pipeline.
Use HTTPS, rotate keys, restrict scopes, and monitor API activity with audit logs to maintain security.
Documentation for the integration is available in the Developer Portal and the Acadimiat integration guide. You can also contact support for best-practice recommendations.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
