Przejdź do treści
DcoyoAI Front Desk

Dla programistów

To samo API, na którym działa nasz panel.

Wersjonowane REST API i podpisane webhooki dla wizyt, wywiadów, podsumowań, połączeń i zadań. API jest na etapie projektowania i zostanie udostępnione partnerom wraz z pierwszym wydaniem.

Konwencje.

Przewidywalne od początku, aby integrację można było napisać raz i na niej polegać.

Styl
REST przez HTTPS, JSON, wersja w ścieżce.
Uwierzytelnianie
Poświadczenia klienta OAuth 2.0, krótkotrwałe tokeny, zakresy dla każdego zasobu.
Idempotencja
Nagłówek Idempotency-Key przy każdym POST. Klucze są przechowywane przez 24 godziny.
Paginacja
Kursorowa, do 100 elementów na stronę.
Błędy
JSON w formacie problem details ze stałym kodem i identyfikatorem żądania.
Limity zapytań
Dla klienta i dla placówki. 429 z nagłówkiem Retry-After.
Wielodostępność
Token jest powiązany z jedną placówką lub z partnerem mającym jawne uprawnienia do placówek.
Czas
ISO 8601 w UTC, ze strefą czasową placówki podaną osobno.

Endpointy.

  • GET/v1/availabilityWyszukiwanie wolnych terminów według specjalisty, rodzaju i przedziału czasuappointments:read
  • POST/v1/appointmentsRezerwacja terminuappointments:write
  • PATCH/v1/appointments/{id}Przełożenie lub odwołanieappointments:write
  • POST/v1/intakesUtworzenie wywiadu dla wizyty; zwraca link dla pacjentaintakes:write
  • GET/v1/intakes/{id}Status i postęp wywiaduintakes:read
  • GET/v1/summaries/{id}Ustrukturyzowane podsumowanie z wersjamisummaries:read
  • GET/v1/summaries/{id}/documentWygenerowany PDF lub zwykły tekstsummaries:read
  • GET/v1/callsRejestr połączeń, podsumowanie i transkrypcjacalls:read
  • PATCH/v1/tasks/{id}Przydzielanie i zamykanie zadań z kolejkitasks:write
  • POST/v1/webhooksRejestracja endpointu i subskrybowanych zdarzeńwebhooks:write

Webhooki.

Ładunki zawierają identyfikatory i statusy, nigdy treści kliniczne. Państwa usługa pobiera szczegóły własnym tokenem.

Połączenia

  • call.started
  • call.completed
  • call.transferred
  • call.abandoned

Terminarz

  • appointment.booked
  • appointment.rescheduled
  • appointment.cancelled
  • appointment.no_show

Wywiad i podsumowanie

  • intake.started
  • intake.completed
  • summary.created
  • summary.signed

Bezpieczeństwo

  • flag.raised
  • escalation.started
  • escalation.acknowledged

Integracja

  • emr.write.succeeded
  • emr.write.failed

Zadania

  • task.created
  • task.resolved
POST https://partner.example/hooks/dcoyo
Dcoyo-Signature: t=1794400000,v1=5f2c...
Dcoyo-Event-Id: evt_01JC...

{
  "id": "evt_01JC...",
  "type": "intake.completed",
  "created_at": "2026-11-11T14:05:38Z",
  "clinic_id": "cl_8f2...",
  "data": {
    "intake_id": "in_3aa...",
    "appointment_id": "ap_91c...",
    "summary_id": "sum_01J...",
    "completeness": { "required_filled": 7, "required_total": 8 },
    "flags": ["urgent_same_day"]
  }
}
  • Podpis to HMAC-SHA256 znacznika czasu i treści, obliczony z sekretem Państwa endpointu. Należy odrzucać wszystko starsze niż 5 minut.
  • Dostarczanie odbywa się co najmniej raz. Duplikaty należy usuwać według identyfikatora zdarzenia.
  • Nieudane dostarczenia są ponawiane z wykładniczym opóźnieniem przez 24 godziny.

Każda wizyta lepiej przygotowana.

Prosimy opowiedzieć nam, jak działa Państwa placówka. Pokażemy, jak Dcoyo odbiera telefony, umawia wizyty w kalendarzu i przygotowuje lekarzy.