ECI hosts JobBOSS² for you, and your team opens it at an ECI address. You'll need a Client ID and a Client Secret from ECI's Integration Engine Management Console.
On-premise
JobBOSS² runs on your own server, and your team opens it at your own address, for example https://jb2.example.com. You'll need your company's API key and a JobBOSS² user.
ECI must turn on the API for your company. ECI activates every API it offers before it can be used. If nobody at your company has set up an API integration before, contact your ECI account manager or ECI support. Ask them to:
activate the JobBOSS² API for your company
give you a Company Manager login for the Integration Engine Management Console, or create a JobBOSS² API user for you
If ECI creates the API user for you, they'll send you a Client ID and a Client Secret. Skip to Step 2.
Choose the JobBOSS² public API as the user's product.
4.
Give the user a name that says what it's for, for example "Makini".
5.
Save. The console shows the new user's Client ID and Client Secret.
6.
Copy both values and paste them somewhere safe for a moment. A password manager is best.
Treat the Client Secret like a password. Anyone who has it, together with the Client ID, can read and change your JobBOSS² data. Don't email it, don't put it in a chat message, don't save it in a shared document.
Use a user that's only for Makini
A separate API user for Makini lets you see its activity on its own, and you can switch it off without affecting your other integrations.
You'll need a JobBOSS² administrator. Creating a user and reading the company's API key both happen in JobBOSS² settings.Check whether your server can be reached from the internet. If your team only opens JobBOSS² inside your office or over a VPN, you'll turn on Connect to on-prem system via VPN/Firewall in Step 3. Have your network details ready, or your network team nearby.
Create a new View Only user with a name that says what it's for, for example APIUSER, and a strong password.
A user that's only for Makini means everything Makini does in JobBOSS² is recorded under that user, so you can always tell it apart from what your team did. View Only is enough for Makini to read your data. If you want Makini's AI tools to create or change records, give the user the rights for that too.
Treat the API key and the password like passwords. Together with the username, they let anyone sign in to your JobBOSS² company. Don't email them, don't put them in a chat message, don't save them in a shared document.
Cloud: the API user being deleted or set to inactive in the Management Console. Reactivate it, or create a new one and enter its Client ID and Client Secret on the connection.
Cloud: ECI deactivating the JobBOSS² API for your company. Ask ECI to turn it back on.
On-premise: the Makini user being deleted or disabled, or its password being changed. Update the connection with the new details.
On-premise: moving JobBOSS² to a new address. Update JobBOSS² URL on the connection.
On-premise: firewall or network changes that block the route to your JobBOSS² server.
