Overview
Configuration is provided for establishing connections with Faire service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Configuration
The provided configuration handles the authentication aspect of communicating with the service. To invoke endpoints, specific to you integration needs, consider defining custom resources (to be used with REST Source and/or REST Destination) or use the REST Web Service Request Task. If you have suggestions for further improvements, we will be happy to hear your feedback.
Download the configuration from here. Then review the KB article posted here how to use the configuration.
Base URL address: https://www.faire.com/api/v1
.
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Token: Required. Specify the token.
The following request parameters will be automatically processed during the authentication process:
-
X-FAIRE-ACCESS-TOKEN:
{{=connection.user.Token}}
Documentation: https://faire.github.io/external-api-docs/#introduction.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
-
limit:
{{=parameters.batchSize}}
-
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
Knowledge Base
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.