API Access Keys

The Sequentum Enterprise API can be restricted to certain groups of agents. An access key can be mapped to a directory of agents, and the key will then need to be specified with all API calls to access agents in that directory.

Viewing or changing the API access keys needs Run as administrator. Only administrators and the Sequentum Enterprise service can read the key file.

The API Access screen can be opened from the Application menu in the Sequentum Enterprise editor.

APIACC.jpg

The option API key required can be set to require a key for all API access.

A key can be assigned the following access to agents.

Run - the key provides access to run agents and view agent statuses.

Data - the key provides access to data extracted by agents.

Schedule - the key provides access to schedule agents.

Full - the key provides full access to agents.

IP - the key is tied to an IP address and works only from that address. Its value cannot be used as a key from any other address.

If an access key is specified with an API call, Sequentum Enterprise will determine the agent's path from the key, so only the agent's name should be specified, not the full agent path.

Example:

  1. http://localhost:8004/ContentGrabber/RunAgentReturnJson?key=cbac266dc49547f4b142bc41d929eb0f&agent=linkedin

  2. The key can also be sent in the X-Api-Key header instead of the URL, so it does not appear in the request line. Example: curl -H "X-Api-Key: <key>" http://localhost:8004/ContentGrabber/RunAgentReturnJson?agent=linkedin. A server can refuse keys sent in the URL; see Configure Service.