Contents
Purpose
Viewing the Customer's API
Locating the API URL
API Internal Login
Viewing API Company Information
Viewing API User Information
Purpose
The purpose of this document is to help the user view a customer's API companies and users. For information regarding the installation of the API and how to find a customer's URL for their API, see API Information and Installation Process.
Viewing the Customer's API
To confirm which version the customer may have if any, follow the steps below:
- Open Octopus.
- Enter Customer Name in 'Filter by Project Name' field.
- Look for records for the customer.
- Note that common customer names may require further research to confirm correct customer API.
- Determine API Type.
Locating the API URL
To find the API URL, from the screen shown above:
- Click the Customer's name
- Click 'Variables'
- Scroll to bottom of screen and locate 'Urls:URL'
- Copy the URL
Past the URL into a browser to open the customer's API
Top of Document
API Internal Login Information
To access a customer's API to view setup of companies and users, the following login information can be used:
Username: automatedjob
Password: Perennial$0ftware
IMPORTANT NOTE: Do NOT give this login information to any customer! It is internal only. Please be careful logging in, incorrect attempts may require reset and notification to all internal users of any updated information.
Top of Document
Viewing API Company Information
To view the customer's companies setup, launch the customer's URL and use the login information above to access their API. Then click the Company button
Viewing API User Information
To view the users a customer has set up, launch the customer's URL and use the login information above to access their API. Then click the Users Button
To see the customer's users, click the Company Users checkbox:
The list of users will now show the API users set up for the customer. Note: When exiting, you will need to uncheck and recheck the Company Users box to refresh the view.
