Sage Developer Workspace - Getting started
Less than to read
- Log in with your Sage ID. If you do not have one, please create one.
- Create a Developer Workspace. Workspace name and email address are required. Address information is not required.
- Click your new Developer Workspace to open it.
- Click Create App to create a new application. Give it a name to identify it in your workspace.
- Click your new application to open it.
- Click Add API.
- In the Sage Product API dropdown menu, select Sage Intacct.
- Enter a Redirect URI and Allowed Origin Domains. For now you can use
- Enter your Intacct Web license key and Intacct Web license Password. These are your Sender credentials from Sage Intacct.
You will not be able to proceed without valid sender credentials.
- Click Save to finish registering your client application.
- Navigate back to Workspaces to see API usage related to your workspace.
To access API metrics, you must first complete the above steps to create a workspace and register your client application
Click the API Usage button in your developer workspace list to view metrics on how your application is using the Sage Intacct API.
It can take up to 10 minutes for metrics to be available after you bind your Web license key and Intacct Web license Password to your application for the first time.
- Application ID: This is a pre-filtered report of your sender ID.
- Company: Filter by company ID.
- Company Type: Filter by company Type.
- Year: Filter your report by year.
- MonthYear: Filter your report by month and year.
- Date: Filter your report on a specific date.
API metrics should not be used to determine billable API totals.
The intention is to provide insight on usage across companies to help optimize API consumption.
It could be up to 2-3 days before the API metrics reflect actual usage.
Transaction = A single API record, there could be several records in one request, each record equals a transaction for create, update, and delete operations.
A query transaction can return many records; each query counts as one transaction.
Request = a group of transactions within one payload
Q: What is Redirect URI, Allowed Origin Domain, Client ID and client secret used for?
A: These are used for the Sage Intacct REST API which will be available at a future date.
Q: How often are the metrics refreshed?
A: Twice a day
Q: How far back can we report?
A: 4 months
Q: How do I get support for issues with the Developer Workspace?
A: Open a case with support for assistance.
Q: What is a Developer Workspace?
A: A developer workspace is a container that houses client application credentials.
Q: What is an application and why do I need it?
A: An application houses API client credentials. This is where you bind your pre-existing sender ID to your application, which is required to view API metrics for the application.