Swagger – Getting started

Our API is documented with Swagger and can be found at this url https://sandbox-api.kolibri24.com/swagger. Although the documentation is self explanatory here are some quick starters and tips.

Controllers and methods

All of our Controllers have their own tab(1) containing the publicly available methods. If you open a Controller tab you’ll find the available methods(2) with a short description of what this method does.

Figure 1: Controllers

Figure 2: Methods

Request method and parameters/request

When you open a method tab you’re presented with additional data, let walk through this:

Request method(3)

GET/POST/DELETE: the type of request method your request should use. When using GET you should use Query String Paramaters, else it should be a Request Payload/Body.

Figure 3: Request method

Request url

Endpoint for this method. If the url contains a option with curly braces (/v3/{RealEstateAgencyId}/AccountSettings) this is one of the parameters that should be passed.

Parameters

When the request method is of type GET the parameters show the required (marked with a asteriks) and optional parameters.

Request (body)

When the request method is of type POST or DELETE the request is split up in two possible sections, a body section where you’ll see a example payload and you can switch(4) to an detailed model. It will optionally have a second set of parameters that match options in the url (/v3/{RealEstateAgencyId}/AccountSettings).

Figure 4: Toggle model view

Responses

The opened method tab also includes all possible responses. All responses are setup in the same way as the previous request body, a example payload and an option to switch(4) to an detailed model.

Try it out

The swagger documentation is not just static documentation, all methods can be called from the documentation. To do this first you need to have a valid session. At the top of our documentation click on the authorize button. In the opened modal(5) enter the client_id (k24_app) and select all three checkboxes. Next click on authorize and if asked login with your Kolibri login.

Figure 5: Authentication modal

Once the previous steps have successfully been completed you can open a method you wish to execute and click on the “Try it out” button. Next fill out the required params and or request body and click on the large blue execute button. You should now see a request being made and a response being presented.

Client generators

Are you in need for a client for our API? You can generate these yourself, checkout swagger.io/tools/swagger-codegen for more info on this, or read our PHP example: Example: Generating a PHP client