Request an APP
This API will allow your clients to manage their inventory on our Supported sites in real-time (if you want to implement that way). If you are not very confident if we have the proper features to you to use, please request a demo session through e-mail: api-mercury-support@olx.com.
Register as a Developer
Before you can use the OLX Group API, you need to register as a Developer. Please use this page to do that.
Required Info | Notes |
---|---|
Name | Name and surname or company name |
Email that will be used to create your account | |
Phone number | A phone number where we can reach you |
Sites | Choose one or more: olxro / olxpl |
Description | Describe briefly the purpose of your integration |
After submitting the form, you will need to confirm the registration by clicking on the activation link sent to the email address provided.
Registering an account does not mean that you will be able to use the API. Your account must be approved. This process may take a few days so please be patient.
Create a new application
Once your developer account is approved you can log in to your account. Let’s open an Application Manager and select the Applications tab on the left. Then click on the New Application button and fill in the form:
Required Info | Description | Required | Notes |
---|---|---|---|
Name | The name of your application | Mandatory | |
URN | It will be completed automatically. In case the URN is occupied, you can change it. | Mandatory | |
Logo | Logo to be displayed on the authorization page on our Sites. | Optional | Formats allowed: .png or .jpegMax resolution: 400x400Min resolution: 100x100Ratio 1:1 |
URL | The application's homepage URL | Mandatory | |
Authentication callback URL | Within the OAuth2 Authorisation Flow, we'll be redirecting the Application User to this Callback URL | Mandatory | |
Notification secret | A string which will be used to sign the webhook | Optional | A private key that will be used to create a HMAC SHA1 signature of the generated JSON content of the notification. |
Notification callback URL | The Callback URL which you will receive notifications | Mandatory | This URL must be able to respond to unauthenticated POST requests with a JSON payload such as the one in the Webhooks (setup notifications). Although not required, we highly recommend that this URL is served by HTTPS. We expect to receive a 2xx code from this URL. |
If the form has been completed correctly, the credentials will be automatically generated when you save the form.
🚧
The Client ID, Client Secret, and API Key that you've been given are private information. It's very important to never share it with anyone (including committing it to a repository). We recommend to store them in the environment variables.