API Access

The File System Connector Service allows any (authorized) http client to utilize the operations it provides. By activating the API Access, the File System Connector can for instance be used from Flow Connect using it's http capabilities.

The connector service exposes three OData services, one for its directory operations, one for its file operations and one for its zip operations.

Configuring allowed clients are done in the connectors web UI.

• Go to section "API Access"

• Press button "New access"

  • Give the access a descriptive name, optionally a version and notice (copy) the API Key, press "Create"

• From an http client, set a header called 'x-api-key' to the API key and call any of the actions provided by the OData services

Example of request (to the operation Exists on FileMethods.svc)

POST http://localhost:58080/api/FileMethods.svc/Exists

Example of body:

{
	"input" : {
		"Path" : "F:\\APIPATH\\file1.txt"
	},
	"connectorConfiguration" : "myConfig"
}

For more information about available operations, check the OData metadata service descriptions linked from API Access page. The 'connectorConfiguration' member above can be either the name of the connector or it's ID. If you have multiple configurations with the same name, it is undefined which of the connectors will process the request (probably the first one that was created). So if you got the ID, use it. (Tip: you can see the connector configurations ID in the url when clicking 'Edit' on it in web UI)

If you disable an operation, it will not be usable from API either. It will return an error if used.