E-conomic Authenticate an Element Instance

Last Modified on 02/04/2019 9:31 am MST

On this page

You can authenticate with E-conomic to create your own instance of the E-conomic element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the E-conomic platform.

Authenticate Through the UI

Use the UI to authenticate with E-conomic and create an element instance. Because you authenticate with E-conomic via OAuth 2.0, all you need to do is add a name for the instance and enter the App Secret Token and App Public Token you recorded in API Provider Setup. After you create the instance, you'll log in to E-conomic to authorize Cloud Elements access to your account. For more information about authenticating an element instance, see Authenticate an Element Instance (UI).

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated element instance with a token and id.

To help you authenticate using our APIs, try the Run in Postman button below. After you import the collection, take a look at the docs.

Authenticating Users and Receiving the Authorization Grant Code

Provide the oauthUrl in the response from the previous step to the users. After users authenticate, E-conomic provides the following information in the response:

code

state

Response Parameter

Description

code

The authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Cloud Elements uses the code to retrieve the OAuth access and refresh tokens from the endpoint.

state

A customizable identifier, typically the element key (economic) .

Note: If the user denies authentication and/or authorization, there will be a query string parameter called error instead of the code parameter. In this case, your application can handle the error gracefully.

Authenticating the Element Instance

1

Redirect URL

2

Authenticate Users

3

Authenticate Instance

Use the code from the previous step and the /instances endpoint to authenticate with E-conomic and create an element instance. If you are configuring events, see the Events section.

Note: The endpoint returns an element instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this element instance.

The authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Cloud Elements uses the code to retrieve the OAuth access and refresh tokens from the endpoint.

string

Namename

The name of the element instance created during authentication.

string

oauth.api.key

The API key or client ID obtained from registering your app with the provider. This is the App Secret Token that you noted in API Provider Setup.

string

oauth.api.secret

The client secret obtained from registering your app with the API provider. This is the App Public Token that you noted in API Provider Setup.

string

oauth.callback.url

The URL that the API provider returns a user to after they authorize access. This is your app's Callback URL Name.

string

Tagstags

Optional. User-defined tags to further identify the instance.

string

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{"id":84975,"name":"API Instance 1","createdDate":"2018-03-21T16:57:00Z","token":"","element":{"id":11005,"name":"E-conomic","key":"economic","description":"Add a E-conomic Instance to connect your existing E-conomic account to the ERP Hub, allowing you to manage all of your ERP activities across multiple ERP Elements. You will need your E-conomic account information to add an instance.","image":"https://images.cloudelements.io/2743_2743_e-conomic-logo201712051817.png","active":true,"deleted":false,"typeOauth":false,"trialAccount":false,"resources":[],"transformationsEnabled":true,"bulkDownloadEnabled":true,"bulkUploadEnabled":true,"cloneable":true,"extendable":true,"beta":false,"authentication":{"type":"oauth2"},"extended":false,"hub":"erp","protocolType":"http","parameters":[]"private":false},"elementId":11005,"tags":["Docs"],"provisionInteractions":[],"valid":true,"disabled":false,"maxCacheSize":0,"cacheTimeToLive":0,"providerData":{"code":""},"configuration":{},"eventsEnabled":false,"traceLoggingEnabled":false,"cachingEnabled":false,"externalAuthentication":"none","user":{"id":123456,"emailAddress":"claude.elements@cloud-elements.com","firstName":"Claude","lastName":"Elements"}}