Agent Key

Endpoint

https://line.cammsoft.com/v1/application/keys/agent.api

Info

This endpoint provides an access key that allows an authorized agent to access available agent endpoints.

This access key has a life span of 24 hours.

Warning

This resource is only accessible to authorized applications.

Repeated authentication failures will result in the banning of the offending IP address.

GET, POST

Input Header Parameters

application-keyRequired

This endpoint accepts either GET with paramaters passed over query string, or POST with parameters passed as JSON in the body.

Either method requires an 'id' and 'name' parameter and then may be passed any addition identifying parameters.

GET

Input Query String Parameters

agentIdRequiredThis systems version of ID of the agent your requesting a key for.

nameRequiredThe name you would like displayed for this agent session. Ex: John Smith, John Smith (Admin)

POST

Input JSON Parameters

{}Object {}RequiredROOT

agentIdStringRequiredThis systems version of ID of the agent your requesting a key for.

nameStringRequiredThe name you would like displayed for this agent session. Ex: John Smith, John Smith (Admin)

On Success

Output JSON Parameters

{}Object {}ROOT

agentIdStringThis systems version of ID.

keyStringKey to be used for all agent endpoints and sockets.

expiresNumberTimeStamp of when this key expires.

On Failed

Output JSON Parameters

{}Object {}Root parameter type.

errorObject {}

codeStringError short code string.

messageStringGreater description of error.

Codes: METHOD_NOT_ALLOWED, AGENT_NOT_FOUND, AGENT_DISABLED, BAD_REQUEST, INTERNAL_ERROR, ACCESS_DENIED, BANNED

CammSoft Line