How to test our API?
Step-by-Step Guide
This step-by-step guide walks you through accessing our API, from authenticating yourself and obtaining your API key to testing the various endpoints, all in just a few minutes. You will be able to test the endpoints directly from the documentation.
Go to this page to access the swagger interface.
Scroll down the page until you reach this part:
Click the Authorize button.
In the pop-up window, enter the Username and Password provided by email.
Click the first Authorize button, then close the pop-up window.
Caution
No confirmation message will appear – this is normal.
Locate the POST method called GetNewApiKey, then click the Try it out button.
Now, click the Execute button.
The authorization key is located within the server response section, directly below the Execute and Clear buttons, and is required for Step 4 - Use the API.
Copy the “value” field from the server response.
Note
The cURL should look like this:
And, the 200-server response should look like this:
Go to this page to use the API.
Scroll down the page until you reach this part:
Click the Authorize button.
Paste the authorization key in the required field.
Now, click the Authorize button.
Note
You can now try any of the endpoints available in the documentation. If you still have doubt on how to use an endpoint? Check this example out.
After you've done steps 1, 2, 3 and 4, you can use this example to learn how to use an endpoint.
Select the POST method called "/olfeo.database.v1.CategorizeService/GetCategory"
Click the Try it out button.
Change the request parameters
{ "host": "olfeo.com", "url": "/check/for/this.html?q=foo" }by what you want to test, for example:
Click the Execute button.
All information regarding the application will be accessible in both English and French within the server response section, immediately beneath the Execute and Clear buttons.
You are now free to use any endpoint you like.