Resources
Po polsku
API w skrócie po polsku: dla agencji i właścicieli placówek.
Ta strona w kilku akapitach mówi po polsku, co daje API pozyskajpacjenta.pl i od czego zacząć. Pełna dokumentacja jest po angielsku, bo po angielsku czytają ją programiści, agencje i generatory kodu.
Do czego służy API
API v1 daje własnemu frontendowi te same dane, z których powstaje strona placówki na naszej platformie: podstrony i bloki treści, zabiegi, zespół, realizacje, aktualności, motyw graficzny i profil placówki. Przez API możesz też:
- wysyłać zapytania pacjentów z własnych formularzy do listy Zapytania w panelu placówki, z e-mailem do recepcji,
- umawiać wizyty w tym samym kalendarzu co strona placówki, jeśli placówka prowadzi grafik w panelu,
- wysyłać prośbę o termin, jeśli placówka prowadzi kalendarz we własnym programie,
- wgrywać zdjęcia do biblioteki mediów,
- odbierać każde nowe zapytanie webhookiem
lead.created, podpisanym HMAC-SHA256.
Zmiany w v1 tylko dodają ścieżki i pola; zmianę, która coś zaostrza, oznaczamy w changelogu jako „behaviour change”.
Od czego zacząć
- Placówka tworzy klucz w panelu: Ustawienia → Integracje → Klucz API → Wygeneruj klucz. Klucz zaczyna się od
pp_live_, jest widoczny tylko raz i trzymasz go wyłącznie po stronie serwera. - Każde zapytanie wysyłasz z nagłówkiem
Authorization: Bearer <klucz>na adreshttps://app.pozyskajpacjenta.pl/api/v1. - Dalej prowadzi Quickstart, a wszystkie endpointy z przykładami w cURL, TypeScript i PHP (WordPress) są w API reference.
Limit to 120 zapytań na minutę na klucz. Dane pacjentów (imię, telefon, e-mail) przetwarzamy w imieniu placówki; pod każdym formularzem pokazujesz jej klauzulę informacyjną z GET /privacy.
Słowniczek
| Po polsku | W API i dokumentacji |
|---|---|
| placówka | clinic |
| zabieg | treatment (services) |
| zespół, lekarz | team member (doctors) |
| realizacja | case study (case-studies) |
| aktualność | post (posts) |
| zapytanie | lead (leads) |
| wizyta | appointment |
| wolny termin | slot |
| prośba o termin | request for a time (timeRequest) |
| recepcja | reception |
| klauzula informacyjna | information clause (clause) |
| zgoda marketingowa | marketing consent (marketingConsent) |
| uwaga | feedback |
Pytania o integrację możesz zadać przez stronę kontaktową.