API Reference Overview

All endpoints of the Okasie Partner API

​

API Reference

​

Base URL

https://www.okasie.be/api/external/v1

All requests and responses use JSON (Content-Type: application/json) in UTF-8.

​

Authentication

Send your secret as Authorization: Bearer YOUR_API_SECRET or X-API-Key: YOUR_API_SECRET. See Authentication for scopes and for which dealers your key can reach.

​

Endpoints

​

Listings

Method	Endpoint	Scope	Description
GET	/listings	any key	List listings
PUT	/listings/{externalReference}	write:listings	Create or replace a listing
POST	/listings/bulk-upsert	write:listings	Create or replace up to 100 listings
DELETE	/listings/{externalReference}	write:listings	Take a listing offline (sold or withdrawn)
POST	/listings/{externalReference}/status	write:listings	Change only the status

​

Locations

Method	Endpoint	Scope	Description
GET	/locations	any key	Dealers your key can reach
GET	/locations/{id}/listings	any key	Listings of one dealer

​

Brands

Method	Endpoint	Scope	Description
GET	/brands	none (public)	Makes and models to map to

​

Responses

• Success is always HTTP 200, also when a listing is created. The payload is in data.
• Write endpoints return errors as {"error": {"code", "message"}}; read endpoints as {"error": "<message>"}. See Error Handling.
• GET /listings and the write endpoints return rate limit headers.

​

OpenAPI specification

The OpenAPI specification describes the same endpoints and can be imported into Postman or Insomnia or used to generate a client.

Listings API

Send vehicle listings

Locations API

Check which dealers you can reach