ArztAPI Dokumentation

Wie Credits verbraucht werden:

• Jede API-Anfrage verbraucht Credits: Die Grundlage ist einfach – jede erfolgreiche Anfrage an die API wird mit Credits verrechnet.
• Komplexität und Datenmenge sind entscheidend: Die genaue Anzahl der verbrauchten Credits hängt von mehreren Faktoren ab:
  • Der Anzahl der abgefragten Entitäten (z.B. wie viele Ärzte oder Einrichtungen in einer Sammlung).
  • Der Anzahl der Felder, die Sie für jede Entität anfordern (z.B. nur Name und Adresse versus alle verfügbaren Details wie Sprechzeiten, Spezialisierungen etc.).
  • Der Tiefe und Komplexität von verschachtelten Abfragen (z.B. Ärzte mit ihren zugehörigen Einrichtungen und deren detaillierten Öffnungszeiten).
  • Der Verwendung von anspruchsvollen Filtern und Sortieroptionen.
• Effiziente Abfragen sparen Credits: Fordern Sie nur die Daten an, die Sie wirklich benötigen. Das Abfragen von nicht benötigten Feldern oder übermäßig großen Datensätzen ohne spezifische Filterung erhöht den Credit-Verbrauch.
• Keine Kosten für leere Felder: Felder, die für einen bestimmten Datensatz keinen Wert haben (NULL sind), werden nicht auf den Credit-Verbrauch angerechnet. Sie zahlen nur für tatsächlich gelieferte Informationen.

Beispielhafte Credit-Kosten ("Standard Abfrage"):

Die genauen Credit-Kosten pro Feld und Entität sind transparent in Ihrem API-Dashboard und in der Detaildokumentation der jeweiligen Endpunkte aufgeführt. Hier einige allgemeine Beispiele, um das Prinzip zu verdeutlichen:

Hinweis: Diese Zahlen sind Schätzungen und dienen der Veranschaulichung. Die tatsächlichen Kosten können je nach genauer Abfragestruktur variieren. Wir empfehlen, die Credit-Kalkulationstools in Ihrem Dashboard zu nutzen.

Credit-Management und Transparenz:

• Monatliches Kontingent: Jeder unserer Pläne beinhaltet ein großzügiges monatliches Credit-Kontingent, das für die meisten Anwendungsfälle des jeweiligen Plans ausreichen sollte.
• Zusätzliche Nutzung: Alle Überschreitungen Ihres monatlichen Kontingents werden automatisch am Ende des aktuellen Abrechnungszyklus abgerechnet. Im Dashboard können Sie Ihre bisher genutzten Credits sowie eine aktuelle Kostenschätzung in Echtzeit einsehen.
• Volle Kostenkontrolle: In Ihrem persönlichen Konto-Dashboard haben Sie jederzeit volle Transparenz über Ihre aktuelle Credit-Nutzung, Ihr verbleibendes Kontingent und die Kosten Ihrer einzelnen API-Anfragen.
• Keine Übertragung ungenutzter Credits: Nicht genutzte Credits aus Ihrem monatlichen Kontingent verfallen am Ende des jeweiligen Abrechnungszeitraums und werden nicht in den nächsten Monat übertragen. Gekaufte zusätzliche Credit-Pakete können ggf. abweichende Gültigkeitsdauern haben.