Articles in this section

Set up an OAuth 2.0 connection to Acumatica

Acumatica is a complete cloud ERP platform that provides solutions for all your business management needs.

Acumatica documentation: Developer guides

A. Set up an Acumatica connection

Start establishing a connection to Acumatica in either of the following ways:

  • From the Resources menu, select Connections. Then, click + Create connection at the top right.

    – or –

  • While working in a new or existing integration, you can add an application to a flow simply by clicking Add source or Add destination/lookup.

In the resulting Application list, select Acumatica.

The Create connection pane opens with required and advanced settings.

B. Describe the Acumatica connection

Edit the General settings specific to your account and this connection resource.

Name (required): Provide a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection, and a unique identifier will prove helpful later when selecting among a list of connections that you’ve created.

Application (required, non-editable): A reminder of the app you’re editing.

Mode (required): Select one of the following options:

  • Cloud to connect to a publicly accessible server application

  • On-premise to connect to a server that is publicly inaccessible and has an integrator.io agent installed on it

Agent (required, if On-premise selected for Mode; otherwise not displayed): Select an agent from the list. To connect to an on-premise application, integrator.io requires that an agent be installed on a networked computer. An agent is a small application that allows you to connect to data behind your firewall. When installing an agent, you will specify a unique access token, which then populates the Agent drop-down list. The installed agents connect to integrator.io and establish a reverse SSH tunnel, allowing secure communication without the need to whitelist integrator.io IP addresses in your firewall settings. A single agent can be used by multiple different connections.

C. Provide required Acumatica account information

At this point, you’re presented with a series of options for providing Acumatica authentication.

OAuth.png

Authentication type (required): Select OAuth 2.0 (the cookie option is described separately).

Instance URI (required): Enter the instance URI shown in your Acumatica account URL. For example, http://try.acumatica.com/isv/entity/Default/6.00.001.

Endpoint name (required): Enter the endpoint name found in your Acumatica account under Web service endpoints. Currently, we are supporting the Default, Manufacturing, and Ecommerce as endpoint names.

Endpoint version (required): Enter the endpoint version found in your Acumatica account under Web service endpoints. This setting defaults to the current version.

Configure scopes (required): Scopes are permissions that the Acumatica API defines to limit the access to your account. To select the scopes for this connection,

  1. Click the Configure scopes button.

  2. To access all of the scopes in the API, click the » button.

    – or –

    Check the scopes you want to add, and click the > button.

Caution

Do not add the scope api:concurrent_access. It is unrelated to integrator.io connection concurrency, and it will cause the connection to fail since the expected cookie is not sent along with the token.

360064960151-acumatica-scopes.png

iClient (required): Select the iClient pair that stores the client ID and client secret provided to you by Acumatica. To add an iClient and configure your credentials , click the plus (+) button. Click the edit ( edit.svg ) button to modify a selected iClient. Be sure to give the iClient a recognizable name for use in any other connections.

  • Client ID (required): Enter the client ID.

  • Client secret (required): Enter the client secret. Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s secret safe. When editing this form later, you must generate this value again; it is stored only when the connection is saved and never displayed as text.

Callback URL (read-only): Copy this integrator.io callback URL to provide directions to Acumatica for where to go after authentication. (This URL should be whitelisted with the authorization server.)

How to retrieve Acumatica API endpoint info

 

  1. Sign in to your Acumatica account

  2. Search for Web service endpoints. The search result displays the API in the Endpoints folder.

Notice that it also displays the endpoint name and version, required for your connection:

How to retrieve the Acumatica iClient pair & specify callback URL

 

  1. Sign in to your Acumatica account

  2. Search for connected applications.

  3. Click the resulting menu item Integration > Preferences > Connected applications.

360064858872-acumatica-oauth-1.png
  1. Leave Client ID blank for a new app, or search for an existing app.

  2. Provide a Client name.

  3. Leave Active checked.

  4. Choose Authorization code for the OAuth 2.0 flow.

360065041511-acumatica-oauth-2.png

In the Secrets tab, click Add shared secret. Acumatica displays the value – just this once – for you to copy for the connection’s Client secret and also gives you the opportunity to name the secret and give it an expiration date. Click OK to return to the Connected applications page.

360065041391-acumatica-oauth-3.png

In the Redirect URIs tab, click the + button to add an entry. Paste the Callback URL from the Acumatica connection, above. Press the enter key to commit this URI.

360065041491-acumatica-oauth-4.png

Finally, click the save button (disk icon). Acumatica then assigns the Client ID, which you can copy for the iClient value.

360065041431-acumatica-oauth-5.png

How to connect to an on-premise Acumatica server

 

If your instance of Acumatica is stored on a local server (on-premise), you can establish your connection with the following steps:

  1. Install and activate an on-premise agent.

  2. Enter the localhost URL in the Instance URI field.

OAuth.png

D. Edit advanced Acumatica settings

Before continuing, you have the opportunity to provide additional configuration information, if needed, for the Acumatica connection.

360065500271-shopify-conn-adv.png

Borrow concurrency from (optional): Select another connection from the list....

NOTE: Selecting another app changes form...

Concurrency level (optional): Up to 25 allowed....

E. Test the connection

Once you have configured the Acumatica connection, you have the option to Save & authorize or Cancel your changes.

When you save the connection, Acumatica allows you to sign in, if there is no current session. It then prompts you to review and confirm the scopes. Click Yes, allow.

360065054231-acumatica-oauth-6.png

The new connection is now successfully added to your account. It will be applied to the current source or destination app, if you created it within a flow. Otherwise, you may proceed to register the connection with an integration.

Read more about this connector:

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.