Use REST API

REST API provides a modern, industry-standard REST API for retrieving and updating records in SmartSimple, with interactive Swagger documentation. Each request returns only the records permitted by the business security configuration and permissions of the associated API user.

Who: Global administrators

When to Use REST API

Use REST API when:

• Building a connection between SmartSimple and a third-party system, such as a payment processor, that creates or updates records directly in SmartSimple.
• Importing payment records into SmartSimple from third-party accounting software on a recurring basis.
• Syncing employee records into SmartSimple from a third-party HR platform.

↑ Back to top

Create a New User Access Token

To create a new user Access Token for REST API:

1. Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and then click the Integrations tab.
2. Locate the API Settings section and click API Users.
    
3. Click the edit [pencil] icon next to the applicable user.
4. Click User Access Tokens in the left navigation.
    
5. Click the Generate User Access Token [+] button.
6. Click the Note and Expiration fields and enter the applicable information.
    
7. Locate the Token Type field and click SmartSimple REST API.
    
8. Complete the fields and then click Save.

↑ Back to top

View External API Explorer

The External API Explorer, or Swagger page, stores all the documentation and allows you to log in and test your API calls to the endpoint.

To use the Access Token to view the SmartSimple External API:

1. Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and then click the Integrations tab.
2. Locate the API Settings section and click External API Explorer.
    
3. Click API User Token.
    
4. Click the Value field, paste the token from the Create a New User Access Token section, and then click Save.
    

You can now build a JSON and test the endpoints in the Swagger page.

↑ Back to top

Access REST API Filter Builder

The REST API Filter Builder allows you to build a JSON using different filter conditions.

To access the SmartSimple REST API Filter Builder:

1. Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and then click the Integrations tab.
2. Locate the API Settings section and click SmartSimple REST API Filter Builder.
    
3. Enter the applicable filters and click Generate JSON.
    
4. Click Copy to Clipboard and test it out in the Swagger page shown in the View External API Explorer section.

↑ Back to top