API service

Interactions involved

Following are the interactions possible with the entities mentioned before using the API service.

USER

Creating new user

PATH - /user/

METHOD - POST

NOTES

• This can be used to create new user entry by filling in the username and is auto-triggered when first login is made.

• The username and password provided in the header section must belong to a user entry with elevated privileges.

Searching for usernames

PATH - /user/search

METHOD - GET

NOTES

• This can be used to search for users from the pool of existing users depending on the the username provided.

• The username and password provided in the header section must belong to an already existing user entry.

Looking up a username

PATH - /user/

METHOD - GET

NOTES

• This can be used to view the details associated with a certain existing user entry depending on the username provided.

• The username and password provided in the header section must belong to an already existing user entry.

APIKEY

Creating new access token

PATH - /apikey/

METHOD - POST

NOTES

• This can be used to create new access token by filling in the usage purpose (optional) and the associated expiry date.

• The username and password provided in the header section must belong to the same username in the body section.

Listing all access tokens

PATH - /apikey/search

METHOD - GET

NOTES

• This can be used to list all the existing access tokens associated with a certain user that those belong to.

• The username and password provided in the header section must belong to the same username in the body section.

Looking up an access token

PATH - /apikey/

METHOD - GET

NOTES

• This can be used to view the details associated with a certain existing access token for the user that it belongs to.

• The username and password provided in the header section must belong to the same username in the body section.

Revoking an access token

PATH - /apikey/revoke

METHOD - PUT

NOTES

• This can be used to revoke the validity of an existing access token to ensure that the access token can no longer be used.

• The username and password provided in the header section must belong to the same username in the body section.

SERVICE

Creating new service

PATH - /service/

METHOD - POST

NOTES

• This can be used to create new service by filling in the the message topic, message body, service validity and service name.

• The username and password provided in the header section must belong to the same username in the body section.

Listing all services

PATH - /service/search

METHOD - GET

NOTES

• This can be used to list all the existing service entries associated with a certain user that those belong to.

• The username and password provided in the header section must belong to the same username in the body section.

Looking up a service

PATH - /service/

METHOD - GET

NOTES

• This can be used to view the details associated with a certain existing service for the user that it belongs to.

• The username and password provided in the header section must belong to the same username in the body section.

Revoking a service

PATH - /service/revoke

METHOD - PUT

NOTES

• This can be used to revoke the validity of an existing service to ensure that the service can no longer be used.

• The username and password provided in the header section must belong to the same username in the body section.

Updating a service

PATH - /service/

METHOD - PUT

NOTES

• This can be used to update the message topic, message body, service validity and service name of an existing service.

• The username and password provided in the header section must belong to the same username in the body section.

MESSAGE

Invoking an event

PATH - /message/

METHOD - POST

NOTES

• The username and password provided in the header section must belong to the same username in the body section.