About the Sales Layer category

[anon99371720]

Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: API | Sales Layer Support Center

Connector package documentation

​​Table of Contents

• 1. Setting up HTTP Client Sales Layer
  • 1.1 Steps
• 2. Subscribing to entities from Sales Layer
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to Sales Layer
  • 3.1 Steps
  • 3.2 General concept

1. Setting up the Sales Layer HTTP Client

1.1 Steps

1. In the Alumio Dashboard, go to Clients → HTTP Clients.
2. Create a new HTTP Client and select Sales Layer Client as the prototype of the HTTP Client.
3. Sales Layer has default configuration that does not require to be changed to use.
4. Save the HTTP Client.

2. Subscribing to Entities from Sales Layer

2.1 Steps

1. Go to Connections → Incoming and create a new incoming configuration and select Sales Layer Subscriber as the subscriber.
2. Fill in the Channel Custom Connector ID and Channel Custom Connector Private Keys for the connector you created in Sales Layer Dashboard.
3. Add any request parameters needed to subscribe to the entity (optional).
4. You can optionally add a transformer to transform the request parameters into something you need.
5. Select the Sales Layer HTTP Client to use.
6. You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Sales Layer API documentation on building this connector, so you can easily use the connector based on the Sales Layer API Docs.

Sales Layer uses different custom connectors to import and to export data, so please fill in the connector code and keys for export, to get data from Sales Layer.

Request Parameters

These are the parameters you can provide to get the needed entity based on the official Sales Layer API Docs. Sales Layer can work with empty default values for subscribing.

• Path is the path parameter of the url. For example the {id}.
• Query is defined set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0

Input Transformer

Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.

HTTP Client

This is the HTTP Client configuration you will use to access Sales Layer.

3. Publishing Entity to Sales Layer

3.1 Steps

1. Go to Connections → Outgoing, create a new outgoing configuration and select Sales Layer – Entity Publisher as the publisher.
2. Fill in the Channel Custom Connector ID and Channel Custom Connector Private Keys for the connector you have created in Sales Layer Dashboard.
3. You can also optionally add any transformers to transform the data into anything you need before submitting it to Sales Layer.
4. Select the Sales Layer HTTP Client to use.

3.2 General Concept

The Sales Layer uses different custom connectors to import and to export data, so please fill in the connector code and keys for import, to put data into the Sales Layer.

To fill data using Alumio Sales Layer connector, we need to use the path key and fill the payload key with the data we want to add to Sales Layer as an example

• Path is the path parameter of the url. For example the {id}.
• Query is defined set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

Alumio will send an API request to Sales Layer.

HTTP Client

This is the HTTP Client configuration you will use to access Sales Layer.