Erstkontakt zur API in der App „Kurzbefehle“ auf iPhone oder iPad
Für den Erstkontakt zur API musst du die URL zum „Endpunkt“ der API aufbauen, mit der du kommunizieren möchtest, und diese URL an die Aktion „Inhalte von URL abrufen“ übergeben. Beim Ausführen des Kurzbefehls generiert diese Aktion die API-Anforderung.
API-Anforderung erstellen
Der Endpunkt von Typicode setzt voraus, dass die URL-Anforderung wie folgt formatiert ist:
https://jsonplaceholder.typicode.com/[RESSOURCE]
Der Text in Klammern ist die Ressource, auf die du zugreifen willst. Typicode bietet verschiedene Beispiele für das Testen von Anforderungen. Dieses Beispiel nutzt https://jsonplaceholder.typicode.com/users, um eine Liste von Benutzer:innen anzufordern.
Füge die Anforderung in der App „Kurzbefehle“ auf deinem iOS- oder iPadOS-Gerät zur URL hinzu.
Die Anforderung
usersgibt eine Liste von Benutzer:innen aus.Du kannst die Suche eingrenzen, indem du eine:einen bestimmte:n Benutzer:in über die ID angibst:
https://jsonplaceholder.typicode.com/users/6. Hiermit wird der:die Benutzer:in mit der ID „6“ ausgegeben.Die meisten APIs erlauben Anforderungen in folgendem Format:
https://jsonplaceholder.typicode.com/users?username=Bret. Das „?“ startet die Anforderung, die nach Objekten mit „Name/Wert“-Paaren sucht. In diesem Beispiel sucht die Anforderung?username=Bretnach einem Benutzer, der Bret heißt.Weitere Informationen zu unterstützten Suchen und Anforderungen findest du in der Dokumentation zu deiner API.
API-Anforderung mit der Aktion „Inhalte von URL abrufen“ ausführen
Tippe in der App „Kurzbefehle“ auf deinem iOS- oder iPadOS-Gerät in der Aktion „Inhalte von URL abrufen“ auf „Mehr anzeigen“.
Daraufhin werden die folgenden Optionen für die Typen von API-Anforderungen angezeigt, die du senden kannst:
GET: Mit dieser Anforderung du Daten abrufen.POST: Mit dieser Anforderung kannst du neue Daten erstellen.PUT: Mit dieser Anforderung kannst du Daten durch Ersetzen aktualisieren.PATCH: Mit dieser Anforderung kannst du Daten durch Ändern aktualisieren.DELETE: Mit dieser Anforderung kannst du das in der URL-Anforderung angegebene Objekt löschen.
In diesem Beispiel wird die Anforderung
GETverwendet, um Daten von der API von Typicode abzurufen.Nachdem die Aktion „URL“ deine Anforderung hat und die Aktion „Inhalte von URL abrufen“ für
GET, d. h. für das Abrufen von Daten konfiguriert wurde, kannst du deine API-Anforderung senden.Hinweis: Wenn du die Aktion „Inhalte von URL abrufen“ für
POST,PUToderPATCHkonfigurierst, wird ein weiterer Parameter „Haupttext anfordern“ hinzugefügt. Mithilfe des Parameters „Haupttext anfordern“ kannst du JSON-Daten, ein Formular oder eine Datei als Bestandteil deiner Anforderung an die API senden. Dies bietet dir die Möglichkeit, Daten manuell oder mithilfe von Variablen einzugeben, sodass du Daten an die API senden kannst, mit denen ein Eintrag erstellt, ersetzt oder modifiziert werden soll.Tippe auf
, um die Ausführung des Kurzbefehls zu testen.
Auf den ersten Blick scheint die Antwort der API aus unverständlichem Text zu bestehen. Diese Informationen sind in JSON (Akronym für JavaScript Object Notation) codiert.
Weitere Informationen über die Verwendung von JSON und die Fortsetzung des Kurzbefehls am Beispiel der API von Typicode findest du unter Einführung in die Verwendung von JSON in der App „Kurzbefehle“ auf iPhone und iPad.