OpenAPI referenca

Javni API je opisan u OpenAPI 3.1 dokumentu:

• Interaktivna referenca: sve operacije, parametri, šeme i primeri, sa mogućnošću da probate poziv svojim ključem;
• openapi.json za preuzimanje (generatori klijenata, Postman, Insomnia, testovi ugovora).

Šta sadrži

Deo	Sadržaj
paths /v1/…	ceo javni API za sajtove: agencija, agenti, oglasi, upiti, zahtevi za pokazivanje, asistent, glas
paths feedovi	generički JSON/XML/CSV feed, 4zida feed (po id-u veze i čitljiv link /xml/4zida/…)
webhooks	property.upserted, property.removed, ping, sa zaglavljima i šemom WebhookEvent
components.schemas	PublicProperty, FlatListing, WebhookEvent, Error
servers	produkcija https://app.propertio.rs/api, test https://app.test.propertio.rs/api

Interni API aplikacije (prijava, korisnici, podešavanja, back-office, administracija platforme) nije deo ovog dokumenta i nije javni ugovor.

Dokument se pravi automatski iz koda API-ja pri svakoj izgradnji ovog sajta, pa je uvek usklađen sa onim što radi u produkciji. Šeme odgovora su stroge (additionalProperties: false) za trenutnu verziju; vaš klijent ipak treba da toleriše nova polja (vidi Verzije).

Generisanje klijenta

# TypeScript tipovi
npx openapi-typescript https://developers.propertio.rs/openapi.json -o propertio.d.ts

# PHP, Python, C#, Java … (OpenAPI Generator)
npx @openapitools/openapi-generator-cli generate -i https://developers.propertio.rs/openapi.json -g php -o ./propertio-php

Za TypeScript/JavaScript preporučujemo zvanični @propertio/sdk.