ArztAPI logo

ArztAPI Dokumentation

Willkommen zur ArztAPI Dokumentation. Diese Seite gibt Ihnen einen Überblick über die wichtigsten Bereiche der Dokumentation und hilft Ihnen, schnell zur passenden Detailseite zu navigieren – von der API-Referenz über Statistiken bis hin zu Preisen und Support.

Schnellstart

Wenn Sie ArztAPI das erste Mal verwenden, empfehlen wir Ihnen die folgenden Schritte:

  1. Plan auswählen: Verschaffen Sie sich zuerst auf der Seite Preise einen Überblick über die verfügbaren Pläne, inkludierte Credits und Kosten für zusätzliche Nutzung.
  2. API-Schlüssel erhalten: Melden Sie sich unter arztapi.de/login an und generieren Sie in Ihrem Dashboard einen API-Key.
  3. API-Referenz lesen: Besuchen Sie die API-Referenz (Einführung) , um den Endpunkt, die Authentifizierung und Grundbegriffe von GraphQL kennenzulernen.
  4. Beispiele ausprobieren: Kopieren Sie fertige GraphQL-Abfragen von der Seite API-Referenz → Beispiele und testen Sie diese in Ihrem GraphQL-Client oder über curl.

Kernkonzepte im Überblick

GraphQL & Endpunkt

ArztAPI stellt einen GraphQL-Endpunkt zur Verfügung: 

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

Sie definieren in jeder Anfrage genau, welche Felder und verschachtelten Objekte Sie benötigen. Eine Einführung in Struktur und Abfragemodell finden Sie in der Sektion „Anfragen stellen“ .

Authentifizierung & API-Keys

Alle Anfragen müssen mit einem gültigen API-Key authentifiziert werden. Dieser wird im HTTP-Header x-api-key mitgesendet: 

x-api-key: YOUR_API_KEY

Wie Sie einen API-Key erhalten und sicher verwenden, ist in der Einführung der API-Referenz beschrieben.

Datenmodell & Schema

ArztAPI stellt strukturierte Daten zu Professionals (Ärzt:innen etc.), Einrichtungen, Standorten, Öffnungszeiten, Rollen (Professional <→ Einrichtung) und medizinischen Spezialisierungen bereit.

Eine Schema-Übersicht mit den wichtigsten Collections und Feldern finden Sie in API-Referenz → Verfügbare Daten .

Credits & Kostenmodell

Die Nutzung der API wird über ein Credit-System abgerechnet. Jede Abfrage verbraucht Credits abhängig von der Anzahl der zurückgegebenen Entitäten, der abgefragten Felder und der Komplexität der Abfrage.

Eine kurze Einführung in Ratenbegrenzung und Credits finden Sie unter API-Referenz → Ratenbegrenzung .

Detaillierte Informationen zu Preisen und inkludierten Kontingenten finden Sie auf der Preisseite .

Kontakt

Haben Sie Fragen zur ArztAPI, benötigen Sie Unterstützung oder möchten Sie uns Feedback geben?

Support & Allgemeine Anfragen

Bitte senden Sie eine E-Mail an: support@arztapi.de

Geschäftliche Anfragen

Für Partnerschaften, individuelle Lösungen oder Vertriebsanfragen wenden Sie sich bitte an: sales@arztapi.de

Postalische Adresse

Kraft Fabrik Media Ltd
Kountourioti 6, Villa 1
8560 Peyia
Zypern

Wir bemühen uns, alle Anfragen zeitnah zu beantworten.