Take a Tour

Sugar Integrate gives you easy access to our adapters, common resources, procedures, and APIs.

Welcome Page

Take a Tour Welcome

  Wherever you are in Sugar Integrate, click to return to the Welcome page.

Visit the Adapters Catalog to see the list of adapters — normalized REST interfaces to over 150 API providers. All adapters have standardized authentication, content, error handling, pagination, bulk and HTTP structures. See Adapters Catalog below for more.

3 The Instances view lets you manage your authenticated connections to API providers (adapter instances) and any executed workflows (procedure instances).

 4 Common resources provide a uniform API wrapper around multiple API provider endpoints for given data structures. Developers code to a common API (for example, /contact), and under the hood we route, map, and transform these requests and responses to many different third party cloud APIs, resulting in a one-to-many coding experience. See Common Resources and Transformations below for more.

5 Create and manage workflows with procedure templates and individual procedure executions called instances. See Procedures below for more.  

6 See system logs and review metrics. See Activity below for more.

7 Manage security settings, accounts, and users.

8 Match the look and feel of Sugar Integrate with your company's experience by updating fonts, colors, images, and terminology.

9 Access profile information including your accounts and access credentials, find documentation, and log out. 

10 Get to know our APIs through our interactive API docs. See API Docs below for more. 

Adapters Catalog

The Adapters Catalog provides a list of the API providers available in Sugar Integrate. If you don’t see an adapter that you need, you can build one yourself. If you're ready to learn all about adapters, take a look at Manage Adapters.

1 Search for an adapter by name.

2 Build a custom adapter.

3 Interact with adapters through its adapter card. Authenticate an instance with the API provider, see the API docs, export the adapter, or add your own resources to an adapter.

4 See how many authenticated adapter instances that you connected to the API provider.

5 Labels tell you more about the adapter: the hub that it is in, if it's beta, and if it is a custom adapter (private).

Common Resources Catalog

The Common Resources Catalog page shows your common resources and the prebuilt resources available to you. When you're ready to define your own common resource and map it to one of your API providers, go to Defining common resource & Transformations.

1 View the Common Resources that you already set up.

2 Define a new common resource.

3 See the prebuilt resources that we've already set up based on common use cases. Clone and customize these resources to make them your own.

4 Quickly see the adapters that the prebuilt resources are mapped to.

Procedures

The Procedures page shows all of your procedure templates and enables you to create a new template or set up a procedure instance. See Building Procedures for detailed instructions.

1 Build a procedure template.

2 Use the procedure card to open the template and view it or make changes, export the template as a JSON file, or create an individual instance of the procedure.

3 See how many instances you have of each procedure.

Activity

The Activity page is the central location to monitor your logs and metrics.

1 Search for a specific log entry or metric.

2 Filter the results by date and time.

3 Filter the displayed results based on user accounts, adapters, authenticated adapter instances, and instance tags.

4 Select the type of activity you want to view.

API Docs

Everything you can do in Sugar Integrate, you can accomplish with a uniform API. You can view each of our endpoints and make requests with the interactive documentation.

Take a Tour APIDocs

1 Select any of our platform APIs to interact with Sugar Integrate and manage accounts, work with our adapters, procedures, and hubs, or even create a custom adapter.

2 See how we normalize resources in each of our hubs. Select an authenticated instance within the hub to try out the requests.

3 View our interactive API docs.

4 What the button says: select a resource and try it out. In this case, you'll authenticate an adapter instance.