Synapse

Varsha Neelesh
Varsha Neelesh
  • Updated

List Synapses

Use this endpoint to get the list of synapses created for the required Instance. Details like authentication mechanism, credentials, status, etc. for each synapse will be available in the response. Sensitive data like user name, password, tokens etc. will be masked.

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg
Example

Request Sample

curl --request GET \
  --url https://api.syncari.com/api/v1/synapses \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'syncariId: '

Response Sample

{
  "success": true,
  "requestId": "string",
  "timestamp": "2022-01-10T06:30:32.246155Z",
  "cursor": "string",
  "result": [
    {
      "id": "5ee40b5107b11100015557de",
      "name": "MySalesforce",
      "synapseTypeId": "61b411698945880b7b597b11",
      "status": "ACTIVE",
      "configuration": {
        "userName": "*****",
        "password": "*****",
        "token": "*****",
        "endpoint": "https://test.my.salesforce.com",
        "authType": "UserPasswordToken"
      },
      "createdBy": "5ee168c414eec900017612ab",
      "createdAt": "2020-06-12T23:10:09.339+00:00",
      "updatedBy": "5ee1652277021300011fe232",
      "updatedAt": "2021-11-05T17:33:06.444+00:00"
    },
    {
      "id": "5ee40b5107b11100015557T2",
      "name": "MySalesforce2",
      "synapseTypeId": "61b411698945880b7b597b11",
      "status": "ACTIVE",
      "configuration": {
        "userName": "*****",
        "password": "*****",
        "token": "*****",
        "endpoint": "https://test.my.salesforce.com",
        "authType": "UserPasswordToken"
      },
      "createdBy": "5ee168c414eec900017612ab",
      "createdAt": "2020-06-12T23:10:09.339+00:00",
      "updatedBy": "5ee1652277021300011fe232",
      "updatedAt": "2021-11-05T17:33:06.444+00:00"
    }
  ]
}

 


Get Synapse by ID

Use this endpoint to retrieve the synapse information for a specific synapse by its unique synapseId (Syncari ID of the Synapse). The synapseId is available in the response for the List Synapses API.

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the api is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Path Parameters

 Name
 Type
 Required
synapseId

Unique ID of the synapse

string
required-table (1).svg

Example

Request Sample

curl --request GET \
  --url https://api.syncari.com/api/v1/synapses/5ee40b5107b11100015557de \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'syncariId: '

Response Sample

{
  "success": true,
  "requestId": "1234abcd",
  "timestamp": "2022-01-10T06:30:32.246155Z",
  "result": {
    "id": "5ee40b5107b11100015557de",
    "name": "MySalesforce",
    "synapseTypeId": "61b411698945880b7b597b11",
    "status": "ACTIVE",
    "configuration": {
      "userName": "*****",
      "password": "*****",
      "token": "*****",
      "endpoint": "https://test.my.salesforce.com",
      "authType": "UserPasswordToken"
    },
    "createdBy": "5ee168c414eec900017612ab",
    "createdAt": "2020-06-12T23:10:09.339+00:00",
    "updatedBy": "5ee1652277021300011fe232",
    "updatedAt": "2021-11-05T17:33:06.444+00:00"
  }
}

 



Create Synapse

A new synapse can be created using this API. On creation, the status of the Synapse will be NEW. Use the Test Synapse Connection API to authenticate the synapse.

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Body

 Name
 Type
 Required
Notes
name

Unique name provided for the synapse

string
required-table (1).svg Synapse names should start with an alphabet and can only contain alphanumerics, spaces, hyphens or underscores
synapseTypeId
The ID of type of the synapse

 

string
required-table (1).svg
 
configuration
userName
password
token
endpoint
authType
object
string
string
string
string
string
 
authType is one of
UserPassword|UserPasswordToken|ApiKey|ApiSecretKey|
Oauth|SimpleOAuth|NetSuiteTokenBasedAuthentication

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/synapses \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'Content-Type: application/json' \
  --header 'clientRequestId: ' \
  --header 'syncariId: ' \
  --data '{
  "name": "Salesforce",
  "synapseTypeId": "61e2a0f034a0f06932046b53",
  "configuration": {
    "userName": "##########",
    "password": "##########",
    "token": "##########",
    "endpoint": "##########",
    "authType": "UserPasswordToken"
  }
}'

Response Sample

{
  "success": true,
  "requestId": "1234abcd",
  "timestamp": "2022-01-10T06:30:32.246155Z",
  "result": {
    "id": "5ee40b5107b11100015557de",
    "name": "MySalesforce",
    "synapseTypeId": "61b411698945880b7b597b11",
    "status": "ACTIVE",
    "configuration": {
      "userName": "*****",
      "password": "*****",
      "token": "*****",
      "endpoint": "https://test.my.salesforce.com",
      "authType": "UserPasswordToken"
    },
    "createdBy": "5ee168c414eec900017612ab",
    "createdAt": "2020-06-12T23:10:09.339+00:00",
    "updatedBy": "5ee1652277021300011fe232",
    "updatedAt": "2021-11-05T17:33:06.444+00:00"
  }
}

 


 

Update Synapse

An existing synapse can be modified using this API by passing updated values in the properties that need to be updated. 

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Path Parameters

 Name
 Type
 Required
synapseId

Unique ID of the synapse

string
required-table (1).svg

 

Body

 Name
 Type
 Required
Notes
name

Unique name provided for the synapse

string
required-table (1).svg Synapse names should start with an alphabet and can only contain alphanumerics, spaces, hyphens or underscores
synapseTypeId
The ID of type of the synapse

 

string
required-table (1).svg
 
configuration
userName
password
token
endpoint
authType
object
string
string
string
string
string
 
authType is one of
UserPassword|UserPasswordToken|ApiKey|ApiSecretKey|
Oauth|SimpleOAuth|NetSuiteTokenBasedAuthentication

Example

Request Sample

curl --request PATCH \
  --url https://api.syncari.com/api/v1/synapses/5ee40b5107b11100015557de \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'Content-Type: application/json' \
  --header 'clientRequestId: ' \
  --header 'syncariId: ' \
  --data '{
  "name": "string",
  "configuration": {
    "userName": "string",
    "password": "string",
    "token": "string",
    "endpoint": "string"
  }
}'

Response Sample

{
  "success": true,
  "requestId": "1234abcd",
  "timestamp": "2022-01-10T06:30:32.246155Z",
  "result": {
    "id": "5ee40b5107b11100015557de",
    "name": "MySalesforce",
    "synapseTypeId": "61b411698945880b7b597b11",
    "status": "ACTIVE",
    "configuration": {
      "userName": "*****",
      "password": "*****",
      "token": "*****",
      "endpoint": "https://test.my.salesforce.com",
      "authType": "UserPasswordToken"
    },
    "createdBy": "5ee168c414eec900017612ab",
    "createdAt": "2020-06-12T23:10:09.339+00:00",
    "updatedBy": "5ee1652277021300011fe232",
    "updatedAt": "2021-11-05T17:33:06.444+00:00"
  }
}

 


Delete Synapse

To delete a Synapse, provide the synapseId of the Synapse to be deleted, in the endpoint.

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Path Parameters

 Name
 Type
 Required
synapseId

Unique ID of the synapse

string
required-table (1).svg

Example

Request Sample

curl --request DELETE \
  --url https://api.syncari.com/api/v1/synapses/5ee40b5107b11100015557de \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'clientRequestId: ' \
  --header 'syncariId: '

Response Sample

{
  "success": true,
  "requestId": "1234abcd",
  "timestamp": "2022-02-04T06:13:43.734597Z",
  "result": {
    "id": "5ee40b5107b11100015557de"
  }
}




Test Synapse Connection

Use this API to authenticate a synapse in NEW status.

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Path Parameters

 Name
 Type
 Required
synapseId

Unique ID of the synapse

string
required-table (1).svg

 

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/synapses/5ee40b5107b11100015557de/connecction \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'syncariId: '

Response Sample

{
  "success": true,
  "requestId": "string",
  "timestamp": "2022-01-10T06:30:32.246155Z",
  "cursor": "string",
  "result": [
    {
      "id": "5ee40b5107b11100015557de"
}
}




Activate Synapse

Activate a synapse using this API. Synapse activation is a pre-requisite for it to be used in pipelines.

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Path Parameters

 Name
 Type
 Required
synapseId

Unique ID of the synapse

string
required-table (1).svg

 

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/synapses/5ee40b5107b11100015557de/activate \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'syncariId: '

Response Sample

{
  "success": true,
  "requestId": "string",
  "timestamp": "2022-01-10T06:30:32.246155Z",
  "cursor": "string",
  "result":
    {
      "id": "5ee40b5107b11100015557de",
      "name": "MySalesforce",
      "synapseTypeId": "61b411698945880b7b597b11",
      "status": "ACTIVE",
      "configuration": {
        "userName": "*****",
        "password": "*****",
        "token": "*****",
        "endpoint": "https://test.my.salesforce.com",
        "authType": "UserPasswordToken"
      }
}

 



Deactivate Synapse

Deactivate an active synapse. The data is not deleted and the synapse can be activated if needed using the Activate Synapse API.

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Path Parameters

 Name
 Type
 Required
synapseId

Unique ID of the synapse

string
required-table (1).svg

 

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/synapses/5ee40b5107b11100015557de/deactivate \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'syncariId: '

Response Sample

{
  "success": true,
  "requestId": "string",
  "timestamp": "2022-01-10T06:30:32.246155Z",
  "cursor": "string",
  "result": 
    {
      "id": "5ee40b5107b11100015557de",
      "name": "MySalesforce",
      "synapseTypeId": "61b411698945880b7b597b11",
      "status": "ACTIVE",
      "configuration": {
        "userName": "*****",
        "password": "*****",
        "token": "*****",
        "endpoint": "https://test.my.salesforce.com",
        "authType": "UserPasswordToken"
      },
      "createdBy": "5ee168c414eec900017612ab",
      "createdAt": "2020-06-12T23:10:09.339+00:00",
      "updatedBy": "5ee1652277021300011fe232",
      "updatedAt": "2021-11-05T17:33:06.444+00:00"
    }
}

 



Refresh Synapse Schema

The endpoint to refresh Schema for a particular Synapse. This will pull in all the schema changes on the entities in Synapse and update it in Syncari.

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Path Parameters

 Name
 Type
 Required
synapseId

Unique ID of the synapse

string
required-table (1).svg

 

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/synapses/5ee40b5107b11100015557de/refreshSchema \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'syncariId: '

Response Sample

{
  "success": true,
  "requestId": "string",
  "timestamp": "2022-01-10T06:30:32.246155Z",
  "cursor": "string",
  "result":
    {
      "id": "5ee40b5107b11100015557de",
      "name": "MySalesforce",
      "synapseTypeId": "61b411698945880b7b597b11",
      "status": "ACTIVE",
      "configuration": {
        "userName": "*****",
        "password": "*****",
        "token": "*****",
        "endpoint": "https://test.my.salesforce.com",
        "authType": "UserPasswordToken"
      },
      "createdBy": "5ee168c414eec900017612ab",
      "createdAt": "2020-06-12T23:10:09.339+00:00",
      "updatedBy": "5ee1652277021300011fe232",
      "updatedAt": "2021-11-05T17:33:06.444+00:00"
    }
}

 

Share this

Was this article helpful?

0 out of 0 found this helpful