ArztAPI API-Referenz

Willkommen bei ArztAPI! Diese Dokumentation bietet einen umfassenden Leitfaden, um unsere GraphQL-API effektiv zu nutzen und auf aktuelle, strukturierte Daten zu Gesundheitsdienstleistern und Einrichtungen in Deutschland zuzugreifen.

Das API-Gateway leitet GraphQL-Abfragen an Supabase pg_graphql weiter. Für komplexe Suchen (Name + PLZ/Stadt + Spezialisierung) empfehlen wir die Suchfunktionen (siehe Beispiele).

Erste Schritte

1. API-Schlüssel erhalten

Um die ArztAPI zu nutzen, benötigen Sie einen API-Schlüssel. API-Schlüssel werden verwendet, um Ihre Anfragen zu authentifizieren und Ihre Nutzung zu verfolgen.

Sie können einen API-Schlüssel erhalten, indem Sie sich auf unserer Plattform unter arztapi.de/login anmelden.

Nach der Registrierung finden Sie Ihren API-Schlüssel in Ihrem Konto-Dashboard. Bitte halten Sie Ihren API-Schlüssel vertraulich.

2. API-Endpunkt

Alle API-Anfragen müssen an den folgenden GraphQL-Endpunkt gesendet werden:

https://api.arztapi.com/functions/v1/api-gateway

3. Authentifizierung

Authentifizieren Sie Ihre API-Anfragen, indem Sie Ihren API-Schlüssel im x-api-key-HTTP-Header übermitteln.

Beispiel:

x-api-key: YOUR_API_KEY

Ersetzen Sie YOUR_API_KEY durch den tatsächlichen API-Schlüssel, den Sie erhalten haben.

Empfohlen: Suche per Funktionen

Für Autocomplete und kombinierte Filter empfehlen wir die per GraphQL exponierten Suchfunktionen wie:

• search_facilities
• search_professionals

Diese sind für typische UI-Anforderungen (Name + Ort + optionale Spezialisierung) gebaut und vermeiden Limitierungen relationaler Filter in pg_graphql.

Fertige Queries finden Sie unter Beispiele.