Getting Started

To start making requests, you'll need a SitePro user and password to work with. The user's permissions will also be applied to the API.

Getting a token

SitePro API URL: https://api.sitepro.com Your token is created via a 2-step process utilizing the SitePro API. The first step is to authenticate your credentials. To do so, you must perform a POST request to https://api.sitepro.com/token

The body of the POST should contain:

• Grant_type = "password" [Constant]
• NeedsUserProfile = [0 if you don't want the user's SitePro Profile information returned in the response, 1 if you do]
• UserName = [User's Username]
• Password = [User's Password]

Note that the POST must be sent as x-www-form-urlencoded. Otherwise, you'll receive an "unsupported grant type" error.

The response, if successful, will contain the following data:

• access_token [string] = Your token for your current session
• token_type [string] = “bearer”
• expires_in [int] = Total time to live for the token in seconds
• siteprouserid [long] = SiteProUserID of the user
• spcoid [int] = SiteProCompanyID of the user
• error [string] = A summary of any mishaps that might have occurred

If you are successful in retrieving your token, then you must perform a POST to the following URL before you can begin using your token to access the various SitePro applications: https://api.sitepro.com/Account/RecordToken

The token must be included in the Authorization header in your request to do a successful token record. The value for the header must have the following format: bearer [YourTokenHereWithoutTheseBrackets]

Using your token

For any following requests to the API, your request's headers must have the Authorization header.

This key/value pair must be present in all SitePro API requests, since this is how we know it’s you. If your token expires and you perform a request to the SitePro API, you will receive a 401 “Unauthorized” error.