Authentication

Username and Password

The Pelican API uses a username (email address) and password based authentication process. You have to include the values: username and password in each request.

username – This is the email address of a validated Pelican App user. This email address is added to the Pelican App and created by an admin of the app. The section is identified as User Management within the app.

password – This is the password for the address linked to the username attribute above. Since the Pelican API only allows SSL connections, the password is automatically encrypted for each request.

Token Request - MySites Attribute

In the case authentication through the use of a token is desired, you can generate a token to authenticate across all the individual Pelican Apps that you have access to through MySites. This includes sites that have been shared using the “share my site” function on the Pelican Dashboard, but your username and password do not directly have access to. To do this you authenticate with MySites using your username and password to the MySites API with a request for a token to be generated. The response will include the token and the token can now be used to authenticate with all Pelican App’s associated with your MySites. Tokens are valid for 24 hours.

Example MySites token request:

				
					https://mysites.officeclimatecontrol.net/api.cgi?username=Email@domain.com&password=MyPassword&request=get&object=Sites&selection=name:my-site-name&value=name;domain;token

Example token response:

				
					<?xml version="1.0" encoding="UTF-8"?>
<result>
 <Sites>
   <name>my-site-name</name>
   <domain>my-site-name.officeclimatecontrol.net</domain>
   <token>KcRVrDu7Hd6p8YfoXqSq6oln6+nC6eSmY2q12dODy0HEQO5QHkM3dkb/N4OJpshW46JhBj+cwHeRbSgUifI1fwlEQuV0TGLKxiBCq/K3ia2Z8YTQ</token>
 </Sites>
 <success>1</success>
 <message>Retrieved attributes for 1 sites.</message>
</result>