The oboloo API lets your developers connect oboloo to your other systems, such as an ERP, finance or CRM system, so supplier, contract and savings data can be created, updated and read automatically. This page explains what the API covers and how to start using it.
Before you start
What the API covers
Area | What you can do |
Suppliers | List, create and update suppliers; read and update supplier addresses; list, add and filter supplier documents |
Contracts | List, create and update contracts; read and update contract documents |
Savings | List savings with filters, create and update savings, and add or update savings milestones |
Configurations | List and add categories, sub-categories, industries, sub-industries, payment terms, supplier types, contract types, savings types and supplier and contract document types |
Locations and departments | List all locations and departments, and add locations and departments |
Currency | List your active currencies |
Notifications | List the notifications for the user whose key is used |
The API doesn't currently cover Sourcing, supplier scorecards, supplier onboarding or users.
Get an API key
Go to Settings > API Authentication, enter an API Key Name and click Generate API Key. Copy the key straight away: it's shown in full only once. For step-by-step instructions, see Creating and Testing API Keys.
Each key acts as you: requests made with your key run as the user who created it, with that user's access to records.
Keys don't expire: a key works until you refresh or delete it on the API Authentication page.
You're told when a key is created: oboloo emails you a security alert each time a new API key is created on your account.
Use the API documentation
On Settings > API Authentication, click API Documentation. The interactive documentation lists every endpoint with its parameters and sample responses, and lets you send test requests to your own oboloo account:
Under Servers, enter your oboloo subdomain in the domain box. For example, if you use companyname.oboloo.app, enter companyname.
Click Authorize, paste your API key and click Authorize again.
Expand an endpoint, click Try it out, enter any parameters and click Execute. The response is shown in JSON.
In your own integration, send the key as a Bearer token in the Authorization header of each request to https://yoursubdomain.oboloo.app.
Example uses
Create contracts automatically: add new contracts and link them to suppliers when they're agreed in another system.
Keep supplier data in sync: update supplier details in oboloo from your ERP or CRM, or the other way round.
Build your own reports: retrieve contract and savings records to use in your own dashboards or reporting tools.
Common questions
How do I keep our API keys secure?
Store keys in a secure location, never share them publicly, and give each integration its own key so you can delete one without affecting the others. Delete keys you no longer use, and if you get a security alert for a key you don't recognise, delete it straight away.
I get an 'Unauthenticated' response
Check that you copied the whole key and that it hasn't been refreshed or deleted. Refreshing a key replaces it, so any integration using the old key must be updated. If in doubt, create a new key.
Can I see a log of API requests?
No. oboloo doesn't show API usage in the app.
Related articles
If you need further assistance, please contact your internal platform administrator for support. Otherwise please reach out to oboloo's support team. If you are unable to view the above area in the oboloo platform, please check your user permissions and access rights.