Produkt · API

Zbuduj na ProofPilot.

Publiczne REST API zarządza rezerwacjami, voucherami, dostępnością, usługami i klientami programistycznie. Klucze API z ograniczonymi zakresami uprawnień, podpisane webhooki dla pięciu zdarzeń i limit 120 zapytań na minutę na klucz.

Zobacz dokumentację API Załóż darmowe konto

api.proofpilot.app

GET /api/v1/vouchers/WICKED-GIFT-4F2A

{
  "valid": true,
  "voucher": {
    "code": "WICKED-GIFT-4F2A",
    "type": "VALUE",
    "value": 100,
    "remainingValue": 65,
    "currency": "EUR",
    "expiresAt": "2027-07-18T00:00:00.000Z"
  }
}

Klucze i zakresy

Klucz API pokazany raz. Zakresy dobrane do zadania.

Nowy klucz API generujesz w Ustawieniach, a jego pełną wartość widzisz dokładnie raz, w oknie potwierdzenia zaraz po utworzeniu. Każdy klucz ma własny zestaw zakresów uprawnień, więc integracja do sprzedaży voucherów nie musi mieć dostępu do rezerwacji ani danych klientów.

Wartość klucza widoczna tylko raz, przy tworzeniu
Zakresy uprawnień dobierane osobno dla każdego klucza
Odwołanie klucza w jednym kliknięciu, bez wpływu na inne

app.proofpilot/settings/api

Endpointy REST

Rezerwacje, vouchery, dostępność i klienci.

Publiczne API pokrywa dokładnie te zasoby, których potrzebuje integracja: tworzenie i odczyt rezerwacji, wystawianie i realizację voucherów, listę usług i wolnych terminów oraz wyszukiwanie klientów. Każda odpowiedź to zwykły JSON ze standardowymi kodami HTTP, bez niespodzianek.

Rezerwacje: utwórz, odczytaj, sprawdź dostępność
Vouchery: wystaw, zweryfikuj kod, zrealizuj
Klienci: wyszukaj i listuj rekordy fotografa

Dostępne endpointy

GET    /api/v1/availability
GET    /api/v1/services
GET    /api/v1/clients
POST   /api/v1/bookings
GET    /api/v1/bookings/:id
POST   /api/v1/vouchers
GET    /api/v1/vouchers/:code
POST   /api/v1/vouchers/:code/redeem

Zakresy uprawnień

vouchers:read / vouchers:writebookings:read / bookings:writeavailability:readclients:read

Pięć zdarzeń, podpisanych i z historią prób

booking.createdbooking.cancelledvoucher.issuedvoucher.redeemedorder.paid

Dlaczego warto zbudować na tym API

API zrobione tak, jak chcielibyśmy, żeby było

Klucze ze skalowalnymi zakresami

Sześć zakresów uprawnień, od odczytu dostępności po zarządzanie rezerwacjami. Integracja dostaje dokładnie tyle dostępu, ile potrzebuje.

Limit 120 zapytań na minutę

Każdy klucz ma własny limit. Przekroczenie zwraca kod 429 z nagłówkiem Retry-After, więc wiesz dokładnie, kiedy spróbować ponownie.

Podpisane webhooki

Subskrybuj rezerwację utworzoną lub odwołaną, voucher wystawiony lub zrealizowany oraz zamówienie opłacone. Każda dostawa jest podpisana HMAC.

Pięć prób dostawy

Nieudana dostawa webhooka ponawia się do pięciu razy, z rosnącym odstępem, zanim trafi na listę nieudanych.

Zbuduj własną integrację

Widżet rezerwacji na własnej stronie, synchronizacja klientów z zewnętrznym systemem albo automatyczne generowanie voucherów przy promocji.

Dokumentacja generowana z kodu

Referencja API na /docs/api czyta specyfikację OpenAPI wprost z endpointów, więc nigdy nie odbiega od tego, co API faktycznie przyjmuje.

Publiczne API ProofPilot

Klucze API ze skalowalnymi zakresami uprawnień
Limit 120 zapytań na minutę na klucz, z nagłówkiem Retry-After
Endpointy dla rezerwacji, voucherów, dostępności i klientów
Podpisane webhooki HMAC dla pięciu zdarzeń
Pięć prób dostawy webhooka z rosnącym odstępem
Specyfikacja OpenAPI generowana z rzeczywistych endpointów

Częste pytania o API

Skąd wziąć klucz API?+

Generujesz go w panelu, w Ustawieniach. Pełną wartość klucza widzisz dokładnie raz, w oknie zaraz po utworzeniu, więc zapisz ją od razu w swojej integracji.

Co się dzieje po przekroczeniu limitu zapytań?+

API zwraca kod 429 z nagłówkiem Retry-After w sekundach. Limit liczy się osobno dla każdego klucza, więc inne integracje danego konta nie tracą dostępu.

Czy webhooki są ponawiane, jeśli mój endpoint nie odpowiada?+

Tak. Nieudana dostawa ponawia się do pięciu razy, z rosnącym odstępem między próbami, zanim trafi na listę nieudanych dostaw w panelu.

Czy jest specyfikacja OpenAPI?+

Tak, dostępna jako JSON pod /api/v1/openapi.json, a pełna, czytelna referencja z przykładami znajduje się na /docs/api.

Bądź na bieżąco

Nowe funkcje, porady o sprzedaży zdjęć i historie studiów. Raz w miesiącu, bez spamu.

Zapisując się akceptujesz politykę prywatności. Wypiszesz się jednym kliknięciem.

Zacznij integrować się z ProofPilot

Załóż darmowe konto, wygeneruj klucz API i wykonaj pierwsze żądanie jeszcze dziś.

Załóż darmowe konto Zobacz dokumentację API