Accessing Web Services#
1.
You must first have been onboarded as a Service Provider in our platforms, including our ITSM platform Assist. Once you have been onboarded, you can request access via Assist by following the below steps
3.
Select Software Request as the Classification
4.
Select API Integration as the System Name
5.
Select API Access as the Request Category
6.
Provide your contact details, so we can contact you if needed to discuss requirements
7.
You will have a User created in both our Test and Production environments.
Authentication#
Octane APIs use Basic Authentication - a Username will be provided to you on the fulfilment of the Assist ticket.You will then be required to do a Password Reset of your API User, and set the Password you want.This Username and Password combination can then be used to authenticate for all APIs.IP Whitelisting#
Octane Test Environment is only accessible to whitelisted IPs. When raising your request for API Access, please also provide a list of IPs that will need to access our Test environment.Octane supports the whitelisting of IP Subnet, so if an entire Subnet needs to be whitelisted, please let us know!
Try it out#
Once installed, you will be able to register for APIDog access, and use the Browser agent to send the API Requests. Doing this ensures that API Requests are being sent directly from your computer/IP and not going through the APIDog cloud server.Remember: our Test environment is only accessible by whitelisted IPs, so you will need to request whitelisting of your IP if you want to try out the APIs directly in the browser!
Getting Access to our Test Portal Environment#
While integrating and testing out our APIs, you may want to check how the various resources you are creating and updating will appear in the Portal itself.To keep user logins secure, Octane utilises 2FA (Two-Factor Authentication) to validate your login. On initial login, you will have an OTP (One-Time-Pin) sent to your registered email that you will need to enter on Octane Login to validate yourself.Octane sends OTP Emails via AWS, and AWS requires your identity and email to be validated as well. During onboarding, our App Support team will trigger a Verification Email to be sent to your registered Email Address from AWS. Please follow instructions on this email to validate your identity. Once done, you will be able to receive OTP Emails for your Octane login.NOTE: If you don't receive a Verification Email from AWS, please contact our App Support team to have it re-triggered.
Summary#
2
Second Step
Get your Octenae API user credentials, confirmation that Whitelisting has been completed, and AWS identity verification email has been sent.
3
Third Step
Check you've received an email from AWS and verify your identity.
5
Fifth Step
Try calling one of the GET APIs with your API credentials to confirm you have API Access.
6
Fifth Step
Congratulations! You are now fully onboarded and ready to start integrating with Octane. Feel free to read some of our integration guides for help on how to sequence your API calls for different use cases.
