Szybki start
Przez REST API pobierzesz dane swojego biura z propertly.io i wyświetlisz je na własnej stronie lub w aplikacji, w dowolnej technologii. Formularze kontaktowe ze strony możesz przez API przesyłać do propertly.io jako leady.
Adres API
https://headless-cms.propertly.io/api/v1Odpowiedzi są w formacie JSON. Endpointy z ofertami zwracają też XML – wybierasz go nagłówkiem Accept.
Uwierzytelnianie
Każde zapytanie musi zawierać klucz API w nagłówku Authorization. Klucz znajdziesz w panelu CRM. Klucz jest przypisany do strony www, więc API zwraca tylko dane organizacji, do której ta strona należy.
curl https://headless-cms.propertly.io/api/v1/organization \
-H "Authorization: <klucz API>"Zapytanie bez klucza kończy się odpowiedzią 401.
Nie umieszczaj klucza w kodzie przeglądarki
Klucz API daje dostęp do danych Twojego biura i pozwala wysyłać formularze w jego imieniu. Używaj go po stronie serwera (np. w Next.js w Server Components lub w API route), a nie w JavaScripcie wysyłanym do przeglądarki.
Endpointy
- Organizacja – dane biura.
- Oddziały – lista oddziałów i szczegóły oddziału.
- Agenci – wszyscy agenci, agenci oddziału i szczegóły agenta.
- Inwestycje – lista inwestycji i szczegóły inwestycji.
- Oferty – aktywne oferty biura, oddziału, agenta lub inwestycji, z paginacją, filtrami i sortowaniem, oraz szczegóły pojedynczej oferty.
- Formularze – przesłanie formularza kontaktowego jako leada.
- Tłumaczenia – etykiety pól i wartości słownikowych w wybranym języku.
Na stronie każdego endpointu wyślesz testowe zapytanie ze swoim kluczem API. Pełna specyfikacja OpenAPI jest dostępna pod adresem propertly.io/openapi.json.
Ostatnia aktualizacja