Open RESTful API

Open RESTful API

Janitorial Manager's open REST API allows data to be pulled.

Who is this API for?	Server Response/Error Codes
Accessing API Calls	FAQ
Authorizing the API
Deprecated Endpoints

Who is this API for?

Janitorial Manager's open API allows certain data to be pulled from your account and into another system. This is useful for companies that:

• Use data visualization tools such as Microsoft PowerBi, Google Charts, etc.
• Need to pull data into other systems.

Please keep in mind that:

• Janitorial Manager cannot provide support or assistance for utilizing the API in external systems.
• This is a one-way API that allows data to be pulled from your Janitorial Manager account.  This API cannot be used to push data from an external system into JM.

Accessing API Calls

Click here to access the open API collection and view available calls.

Client Secret

To pull data from the API, you need your company's client secret. Please contact your account manager or a customer support representative to obtain the code.

Authorizing the API

The API must be authorized before any calls other than /Login can be made.

Generating Access Token

1. On API collection page, expand the /Login call.
2. Click Try it out.
   
3. In the request body, add your username, password, and company's client secret to the appropriate fields. Your data must be added between the quotes, like in the example below:

   {
   "UserName": "ExampleUsername",
   "Password": "ExamplePassword",
   "Clientsecret": "000000-0000-0000-0000-000000000000"
   }

   Inactive user credentials cannot be used.
4. Click Execute.
5. Scroll down to view the Responses. If the call is successful (code 200), the page will generate a server response that includes an access token. The token will be a series of letters, numbers, and special characters. Copy the token to your clipboard.

   {
   "Access_token": "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
   ",
   "Organization": "CompanyName",
   "Token_type": "",
   "Expires_in": 1757115486
   }

Authorizing the API

1. At the top of the page, click Authorize.
2. In the BearerAuth field, paste your access token.
   
3. Click Authorize.

Deprecated Endpoints

Occasionally, certain endpoints may be deprecated or retired. Deprecated endpoints remain functional for a time but will not be updated and may eventually be discontinued.

To avoid disruptions in operation, we recommend transitioning to the latest or updated endpoints as soon as possible.

Server Response/Error Codes

Success Responses

Code	Response	Notes
200	Successful response	The process worked as expected.

Error Responses

Code	Response	Notes
400	Invalid username or password	The credentials (username, password, client secret) used in the /Login call are incorrect.  Verify the credentials before executing the call again.
401	Undocumented	The API has not been authorized or the access token has expired.
4xx	Varies	Codes starting with 4 indicate an invalid API method call.  This typically occurs if the /Login credentials are invalid.
5xx	Varies	Codes starting with 5 indicate a server issue or unavailable API service. Contact customer support if this occurs.

FAQ

Q: What authentication type does this open API use?

A: OAuth 2.0 (access tokens).

For more information, or to send in a request to the Janitorial Manager support department, use the red 'Help' button in the bottom right corner of any Help Desk article.