You can authenticate with Click Field Service Edge to create your own instance of the Click Field Service Edge connector through the UI or through APIs. Once authenticated, you can use the connector instance to access the different functionalities offered by the platform.
Authenticate Through the UI
Use the UI to authenticate with Click Field Service Edge and create an instance. To authenticate an connector instance, complete the steps described in Authenticate a Connector Instance (UI). In addition to the base authentication parameters, you must also include the Host Name.
Authenticate Through API
Send a request to our /instances
endpoint to authenticate an instance.
To authenticate:
Construct a JSON body as shown below (see Parameters):
{ "element": { "key": "fieldserviceedge" }, "configuration": { "filter.response.nulls": "true", "event.vendor.type": "webhooks", "username": "<USERNAME>", "password": "<PASSWORD>", "hostname": "<HOST_NAME>" }, "name": "<INSTANCE_NAME>" }
Call the following, including the JSON body you constructed in the previous step:
POST /instances
Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.Locate the
token
andid
in the response and save them for all future requests using the connector instance.
Example cURL
curl -X POST
-H "Authorization: User <INSERT_USER_SECRET>, Organization <INSERT_ORGANIZATION_SECRET>"
-H "Content-Type: application/json"
-d
'{
"name": "<INSTANCE_NAME>",
"configuration": {
"filter.response.nulls": "true",
"username": "<USERNAME>",
"password": "******",
"hostname": "<HOST_NAME>"
}
}
Parameters
Parameter | Description | Data Type |
---|---|---|
key | The connector key. fieldserviceedge | string |
Namename | The name of the connector instance created during authentication. | string |
User Nameusername | The Click Field Service Edge user name for your account. | string |
Host Namehost.name | The Click Field Service Edge host name for your account. | string |
tags | Optional. User-defined tags to further identify the instance. | string |
Example Response for an Authenticated connector Instance
In this example, the instance ID is 12345
. The actual values returned to you will be unique: make sure you save them for future requests to this new instance.
{
"id": 123456,
"name": "<INSTANCE_NAME>",
"createdDate": "2019-09-20T08:46:09Z",
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"elementId": 1234,
"tags": [
"<TAGS>"
],
"provisionInteractions": [],
"valid": true,
"disabled": false,
"maxCacheSize": 0,
"cacheTimeToLive": 0,
"configuration": {
"base.url": "<BASE_URL>",
"allow.select.fields": "true",
"event.notification.subscription.id": null,
"default.select.fields.map": null,
"event.notification.basic.username": "",
"pagination.max": "100",
"event.notification.basic.password": "********",
"event.vendor.type": "webhooks",
"filter.response.nulls": "true",
"password": "********",
"hostname": "<HOST_NAME>",
"event.notification.instance.finder": null,
"pagination.type": "offset",
"event.notification.callback.url": "false",
"event.notification.signature.key": null,
"username": "<USERNAME>",
"event.notification.enabled": "false"
}...,
"authenticationType": "basic",
"eventsEnabled": false,
"eventsNotificationCallbackUrl": "false",
"cachingEnabled": false,
"traceLoggingEnabled": false,
"organizationId": xxxx,
"accountId": xxxxx,
"externalAuthentication": "none",
"userId": xxxxxx,
"element": {...},
"user": {
"id": xxxxxx
}
}