Configure SmartConnect API Functions and Tokens

SmartConnect API functions define the record type, action, and fields available through each API call. API user access tokens can replace a username and password for authentication in API calls. Each SmartSimple instance has its own functions, and only functions already established in that instance are available. For function settings, field list syntax, endpoints, parameters, request and response examples, and response messages, see SmartConnect API Endpoints, Parameters, and Function Settings Reference, SmartConnect API Sample Code Reference, and SmartConnect API Response Messages Reference.

Who: Global administrators 

When to Use SmartConnect API

Use SmartConnect API when:

• The finance department needs to pull in payments from third-party accounting software.
• The HR team needs to pull in user employment data from third-party software.

↑ Back to top

Create a SmartConnect API Function

Global user administrator permissions are required to add SmartConnect API functions.

To create a SmartConnect API function:

1. Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and click the Integrations tab.
2. Locate the API Settings section, and click SmartConnect API.
3. Click the New SmartConnect API [+] button to create a new function.
4. Click the Function Name field and enter the name.
5. Click the Object Type, Action Type, and Field List fields, and add the applicable information. For field list syntax and the function settings, see SmartConnect API Endpoints, Parameters, and Function Settings Reference.
6. Click Save.

The API Token displays after the function is saved. Include the API Token in all API calls to identify the function. The saved function also displays any required and optional parameters.

↑ Back to top

Set Up API User Access Tokens

To set up an API user access token, create a user with API access, and then generate a token for that user.

Create a User with API Access

Access tokens are generated for API users, a special type of user. A user with API access displays in the API Users list.

To create a user with API access:

1. Create a new user following the steps outlined in Manage Users and Contacts.
2. From the new user's record, click the Actions drop-down menu and select Edit Roles and Access.
3. Locate the Access Type field and click API Access, and then click Save.

↑ Back to top

Generate an API User Access Token

An API user access token can replace a username and password for authentication in API calls.

To generate an access token for an API user:

1. Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and click the Integrations tab.
2. Locate the API Settings section, and click API Users.
3. Click API Users.
4. Click the name of an API user.
5. Click User Access Tokens in the left navigation.
6. Click the Generate User Access Token [+] button.
7. Click the Note field and add a note about the API token.
8. Click the Expiration field, and select the relevant days for expiration from the drop-down menu.
9. Locate Token Type, click SmartConnect API, and then click Save.
10. Click the Copy button to copy the User Access Token.

↑ Back to top

Use an API User Access Token in an API Call

To authenticate a SmartConnect API call with an API user access token:

1. Add the token to the Authorization header of the API call, using the format below.

Bearer xxxxxxxxxxxx

The token replaces the username and password parameters in the call. For authentication error messages, see SmartConnect API Response Messages Reference.

↑ Back to top

Test Sample SmartConnect API Functions

Navigate to the interactive demonstration page to test sample SmartConnect API functions. For request and response examples, see SmartConnect API Sample Code Reference.

↑ Back to top