Dla deweloperów

API: aktualne ceny i wolne komórki Twojego placu na Twojej stronie

Masz własną stronę, porównywarkę albo panel partnera i chcesz pokazywać na nich aktualne ceny i wolne komórki bez ręcznego przepisywania? API Boxi oddaje ogłoszenia jednego placu: cenę, dostępność, wymiary, kaucję i zdjęcia, zawsze takie same jak na stronie wynajmu.

Boxi unosi klucz z sześciokątem, w drugiej ręce wtyczka z kablem do okna z kodem

Jak to działa

Trzy kroki, zero telefonów.

  1. 01

    Generujesz klucz w panelu

    W widoku placu, zakładka API. Klucz `boxi_live_…` widzisz raz, w bazie trzymamy tylko jego skrót SHA-256. Odwołujesz go jednym kliknięciem, a przy każdym kluczu widać, kiedy był ostatnio użyty.

  2. 02

    Pobierasz listę ogłoszeń

    Jedno zapytanie GET z nagłówkiem X-API-Key zwraca aktywne ogłoszenia placu: kod, tytuł, metraż, cenę brutto i netto ze stawką VAT, liczbę wolnych komórek i flagę, czy cena pochodzi z dynamicznego cennika.

  3. 03

    Pokazujesz ceny u siebie

    Szczegóły ogłoszenia dają wymiary, opis, minimalny okres najmu, okres wypowiedzenia, kaucję i wszystkie zdjęcia. Budujesz własny katalog, a przycisk „Wynajmij” kierujesz na stronę wynajmu Boxi, gdzie klient płaci i podpisuje umowę.

2 endpointy
lista i szczegóły ogłoszeń placu
tylko odczyt, zakres jednego placu

Co dokładnie jest w środku

  • Klucz API per plac: boxi_live_ i 32 znaki, pokazywany raz, w bazie tylko skrót SHA-256
  • Nagłówek X-API-Key; brak lub odwołany klucz daje 401, cudzy zasób daje 404
  • Klucz nie wygasa sam, odwołujesz go w panelu; data ostatniego użycia przy każdym kluczu
  • GET /external/listings: aktywne ogłoszenia z ceną brutto i netto, VAT, liczbą wolnych komórek i flagą dynamicznego cennika
  • GET /external/listings/{id}: wymiary, opis, minimalny okres najmu, wypowiedzenie, kaucja, zdjęcia z podpisami
  • Cena z dynamicznego cennika, jeśli jest włączony, więc na Twojej stronie i na stronie wynajmu jest ta sama stawka
  • Publiczna specyfikacja OpenAPI tylko dla endpointów zewnętrznych
  • Rezerwacja i płatność nadal na stronie wynajmu Boxi; API dziś nie zapisuje danych

Pytania i odpowiedzi

Czy jest dokumentacja?
Tak, publiczna specyfikacja OpenAPI z przykładami zapytań i odpowiedzi. Na demo pokażemy ją na żywo razem z kluczem testowym.
Czy przez API mogę założyć rezerwację?
Jeszcze nie. Dziś API jest tylko do odczytu. Klient rezerwuje i płaci na stronie wynajmu Boxi, do której linkujesz z własnego katalogu. Zapis rezerwacji przez API jest na naszej liście rozwoju.
Czy API jest płatne?
Nie ma osobnej opłaty. Klucz generujesz w panelu w ramach pakietu.
Czy mogę mieć kilka kluczy do jednego placu?
Tak, na przykład osobny dla strony i osobny dla porównywarki. Każdy odwołujesz niezależnie. Do drugiego placu potrzebujesz osobnego klucza, bo klucz nigdy nie widzi danych innego placu.

Demo

Zobacz Boxina swoim placu.

30 minut, konkretnie o Twoim obiekcie. Pokażemy rezerwację, otwarcie bramy z telefonu i fakturę na żywo.

  • Rezerwacja i płatność BLIK na żywo
  • Otwarcie bramy z telefonu przy Tobie
  • Faktura w Twoim systemie księgowym

Wolisz napisać? kontakt@boxi.pl

Zostaw e-mail i telefon, oddzwonimy w jeden dzień roboczy.