Anfragen stellen

Die ArztAPI verwendet GraphQL. Alle Anfragen müssen als POST-Anfragen mit einem JSON-Body an den API-Endpunkt gesendet werden.

Der JSON-Body muss ein Feld query enthalten und kann optional ein Feld variables enthalten, wenn Ihre Abfrage Variablen verwendet.

Beispielanfrage mit cURL:

curl --location 'https://api.arztapi.com/functions/v1/api-gateway' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "query GetFirstProfessional { professionalsCollection(first: 1) { edges { node { id first_name last_name title } } } }",
    "variables": {}
  }'

Denken Sie daran, YOUR_API_KEY durch Ihren tatsächlichen API-Schlüssel zu ersetzen.

GraphQL verstehen

Wenn Sie neu bei GraphQL sind, finden Sie hier einige grundlegende Konzepte:

• Abfragen: Lesevorgänge zum Abrufen von Daten. Sie geben genau an, welche Daten Sie benötigen.
• Felder: Die spezifischen Datenelemente, die Sie zu einem Objekt abrufen möchten (z. B. first_name, email).
• Argumente: Parameter, die Sie an Felder übergeben können, um die zurückgegebenen Daten zu beeinflussen (z. B. eine id, um einen bestimmten Professional abzurufen, oder first: 5, um die Anzahl der Ergebnisse zu begrenzen).
• Variablen: Eine Möglichkeit, dynamische Werte in Ihre Abfragen einzubringen.
• Sammlungen: Dienen zum Abfragen von Listen von Elementen (z. B. professionalsCollection). Diese liefern normalerweise ein Array edges, wobei jeder Edge ein node (das tatsächliche Datenobjekt) und einen cursor (für die Paginierung) enthält. Sammlungen enthalten auch häufig totalCount.
• Knoten: Einzelne Datenobjekte (z. B. ein bestimmter Professional oder eine Einrichtung).