REST developer quickstart

Requirements

You must have an active Sage Intacct Web Services developer license, which includes a Web Services sender ID and password.

Note: If you need a developer license, contact your account manager.

Create a new developer workspace

A Sage developer workspace lets you register your client applications and create API client keys. You can invite other developers to join your workspace, and monitor API usage by customer and application.

  1. Go to https://developer.sage.com/intacct/
  2. Click View workspaces, then enter your Sage account email address and password to log in. (If you don't yet have a Sage account, click Create account to register.)
  3. Click Add workspace to create a workspace for your company.
  4. Enter a name for your workspace and a contact email address, then click Create.

Add a client application

Each of your products that you want your customers to use with Intacct must be registered as a separate application.

  1. Click Apps in the left column navigation.
  2. Click Add application.
  3. Enter a name to identify the application in your workspace, a home page URL, and a contact email address for the application, then click Create.

Get API keys

The app registry will issue a unique client ID and client secret for each application.

  1. From the list of applications in your workspace, click your new application to open it.
  2. Click Create API keys.
  3. From the Sage Product API drop-down list, select Sage Intacct.
  4. Enter a Redirect URI as a full URL. During the authorization process, users will be redirected to this URL after authorizing your application to access their data in Sage Intacct. Your application must have a script or code at this URL ready to receive an OAuth authorization code and use it to request a token.
    You can provide multiple redirect URIs as a comma-separated list. The only restriction is that http:// URLs are not allowed; all other formats, including https:// URLs and mobile app URI schemes, are permitted.
  5. If you have custom applications that send Intacct API requests from your domains, enter those domains in Allowed Origin Domains as full https URLs.
  6. Enter your Sage Intacct Web Services sender ID and password.
  7. From the Client Scope drop-down list, select the type of company to associate with these API keys:
    • Non-Production: Choose this option if you're working with a sandbox implementation or other non-production company.
    • Production: Choose this option if you're working with a live production company. Production companies are limited to no more than five associated API keys.
      Note: You cannot change the client scope after it has been set.
  8. Click Create.

When your registration is complete, the Application Details page will include an API Keys section. Click Sage Intacct in that list to view your application's client ID and secret key that you must use in API requests.

Send requests

Use the new client ID and secret in the PHP tutorial or Node.js tutorial, or to send test requests from the API reference pages, or from your own application. To send requests using the Postman application, see the Working with Postman collections tutorial.

Note: Your application's web sender ID must be approved by a company administrator or your API requests will be rejected. There are two ways for your web sender ID to be approved:

  1. A company administrator can log into Intacct and add your web sender ID to the Company Security tab.
  2. When the OAuth flow presents the Intacct login page, log in as an admin user and approve the authorization request. This adds your web sender ID to the list of authorized web services.