• Overall Manual on How to create an Integration (Custom Integration Builder)

  TABLE OF CONTENTS Introduction SyncSpider's Homepage Custom Integrations Look of Custom Integration Page Section 1: User needs to create a template (Custom integration) 1.Add Custom Integration 2.Custom Integration [3. Created Custom IntegrationFew readers

• Data Type

  The Data Type is where we specify the API endpoint we want to use for our template. One can add as many Data Types as needed. Once we add a data type we can name/rename it and turn it off/on(as long as the template is inactive). Let’s head inside the newly made data type and see what options we have. Click on the name of the data type and you will be met with the first sFew readers

• Data Payload Handler - Workflow Action

  Due to its nature, the Workflow feature may create infinite loops in SyncSpider core. That could put our system under high pressure. For that reason, the Workflow feature is only granted to verified developers. _If you are looking to get the Workflow feature, you can reach out to our support chat after you have already built 5 working integrations (which don't require the Workflow feature). These integrations should be built into your account and should be made public after our developers havFew readers

• Required Authentication

  Having checked this box a dropdown selection will be given with the following options: Options Basic Authorization Api Key [Other](https://syncspider-support.freshdesk.cFew readers

• Workflow feature

  _D_ue to its nature, the Workflow feature may create infinite loops in SyncSpider core. That could put our system under high pressure. For that reason, the Workflow feature is only granted to verified developers. If you are looking to get the Workflow feature, you can reach out to our support chat after you have already built 5 working integrations (which don't require the Workflow feature). These integrations should be built into your account and should be made public after our developers havFew readers

• CONFIG

  Here we have the following fields: Request type Used to specify the type of request of the call. Supported: POST, GET, PUT, PATCH and DELETE Type Used to specify the type of data sent/received Supported: JSON, x-www-form-urlencoded and CSV API Endpoint Used to write out the remaining portion of the url used for this particular endpoint Usually stFew readers

• OAuth 2.0 authorization

  When dealing with OAuth 2.0 authorization one can run into all sorts of variations when it comes to the expected fields and grant types. This template represents the default scenario that today may not be used as often as in the past. Here you will find the Client Credentials, Password Credentials and Authorization Code Grant Types, each with a different set of required fields. Additionally at the bottom, just above the Use Custom Header box you will see a Get Access Token buttFew readers

• DYNAMIC URI COMPONENT

  As mentioned before the dynamic url functions with a key(name) and value fields for smooth handling. This way we can easily navigate by viewing and picking among names while handling long and hard to remember values like unique identifiers and such.Few readers

• How to create a Custom API integration template?

  Step 1. First, login to your SyncSpider account, click on the option ‘Custom Templates’ on the left side of the screen as shown below. Step 2. Now, click on the ‘Add Integration Template’ option as shown below. Step 3. Now,Few readers

• Api Key

  With this authentication option we are given two fields, Api key name and value and an API key in URL checkbox which if checked(default)  will send the entered values of these two fields as URL query parameters.Few readers

• SCHEMA

  Here we define what form the expected Content will have using a sample. While on the right side we have the Preview of the Content structure for easier overview of the expected data. Additionally we have the Root schema node field that lets us simplify the sample Content structure by sinking 1 level deeper using the node that’s a level above the data we specifically need. This same screen will await you for both import and export data types. (with only possible differences being lack oFew readers

• PAGINATION

  As stated before this step is only needed when importing data to SyncSpider and is meant to take care of the different syntax in regards to pagination as well as determine the starting point which may vary between systems. Options and fields available are: Disable pagination Used to disable pagination all together. Page Define key for Page (e.g. Page might be “p”) (to remove key from request type '-1') Page start from Define start number for page pagination (0 or 1) LimFew readers

• Oauth2 Template

  As previously mentioned when dealing with this type of authorization we run into a lot of variations with uniquely required fields some of which may be filled the same for all users. Because of this we have decided to separate this process in two parts. The one that our developer will do for you (Required authentication) and the part that you will have to finish yourself (the remaining 3 Pop-up field options). Once you detect that this is indeed the required authentication optionFew readers

• How to add your app to SyncSpider platform

  You can connect your tool in 2 different ways. By using our Custom integration module (our no code module - and from within SyncSpider). All details are here. Or, you can do it old fashion way, just develop a module by using this documentation: https://syncspider.docs.apiary.io/#reference/configuring-custom-api-moduleFew readers

• Connection Config

  The Connection Config is where we establish the connection with the platform API by specifying the type of authorization and customizing the calls by writing down all needed headers. Ultimately this is where we format the connection part of the integration setup pop-up that the user will be filling upon integrating the template before adding it to a task, already connected to their account. Since we are creating a template for users to fill for their integrations we will leave empty the fieldsFew readers

• Custom API connections

  If you are looking for connection with API that is not integrated yet we offer our Custom API module which allows you to create your own integrations. You can access our API documentation and prepare the data format and type SyncSpider expects. From the main app page click the Custom Integrations button and  choose Add Custom Integration as shown below. ![](https://storage.crisp.chat/users/helpdesk/website/Few readers

• XML Support

  With this article we will show you where to find the XML part of our Custom Integration Builder, and the options that it has within it. SyncSpider now supports XML connection as source. We will be working to add target support as well. If you need any other features, please request here, and give us your comments on this functionality First , we will go to the "Custom Integrations" Section. ![](https://storage.crisp.chat/useFew readers

• Basic Authorization

  This is, perhaps, the simplest type of authentication template, giving you the User Name and Password fields. As we mentioned before we leave these for the user to fill.Few readers

• What is a "Data Type" ?

  "Data Types" may differ depending on connection type. What is "Data Type"? e.g. "DataType" specifies the data area of a system. In Magento 1 and 2, there are customers, customer groups, products, categories, invoices, orders and prices. If you got any questions or need any assistance feel free to contact our support through SyncSpider !Few readers

• Existing Tags

  Tag’s can grab the token value from the field or generate a value and either pass it on (in case of {apiKey}) or perform some operation such as encryption and then pass it to the field where the tag resides. {apiKey} {timestamp} {generateNumbers4} {generateNumbers5} {generateNumbers6} {generateNumbers7} {generateNumbers8} {base64_encode | YOUR_KEY} this form can be used for different functions with multiple values which can be used to combine multiple authentication methods inFew readers