Was ist REST API?

REST API (Representational State Transfer Application Programming Interface) ist ein Satz von Regeln, der es verschiedenen Softwaresystemen ermöglicht, über das Internet zu kommunizieren. Stellen Sie sich eine API als eine Brücke vor, die zwei Systeme miteinander verbindet und es ihnen ermöglicht, Informationen anzufordern und auszutauschen.

Lassen Sie uns die Komponenten einer REST-API aufschlüsseln:

• API (Anwendungsprogrammierschnittstelle): Eine API ist wie eine Speisekarte in einem Restaurant. Sie bietet eine Liste von Operationen, die ein Client anfordern kann, und der Server (wie ein Koch) führt diese Operationen aus und gibt die Antwort zurück.
• REST (Representational State Transfer): REST ist eine Reihe von Richtlinien für die Erstellung von Webservices, die über HTTP funktionieren und Standardoperationen wie GET, POST, PUT und DELETE verwenden.

Wie funktioniert eine REST-API?

REST API ermöglicht es Clients (wie Ihrem Browser oder einer App), Anfragen an Server zu senden und im Gegenzug Daten zu erhalten. Lassen Sie uns Schritt für Schritt aufschlüsseln, wie das funktioniert:

1. Kundenanfrage: Der Client (Ihre Anwendung) sendet eine HTTP-Anfrage an eine bestimmte URL auf dem Server. Diese URL steht für eine Ressource (z. B. einen Benutzer, ein Produkt usw.).
   • Beispiel: GET https://api.example.com/users fordert die Liste der Benutzer an.
2. Server Verarbeitung: Der Server empfängt die Anfrage, verarbeitet sie, ruft die Daten ab (normalerweise aus einer Datenbank) und bereitet eine Antwort vor.
3. Server-Antwort: Der Server sendet eine HTTP-Antwort an den Client zurück. Diese Antwort enthält:
   • Status Code: Um anzugeben, ob die Anfrage erfolgreich war (z.B. 200 OK für Erfolg, 404 Not Found, wenn die Ressource nicht existiert).
   • Daten: Normalerweise im JSON-Format, das die angeforderte Ressource darstellt.

Grundlegende Authentifizierung: Was ist das und warum ist es wichtig?

Grundlegende Authentifizierung ist eine einfache Möglichkeit für Benutzer, ihre Identität zu verifizieren, wenn sie eine API anfordern. Bei dieser Methode sendet der Client den Benutzernamen und das Passwort verschlüsselt in der Kopfzeile der Anfrage, die der Server dann validiert.

Warum ist es wichtig?: Die Authentifizierung stellt sicher, dass nur autorisierte Benutzer Zugriff auf Ressourcen haben und verhindert, dass nicht autorisierte Benutzer Zugriff erhalten.

Wie funktioniert es?: Wenn ein Client eine Anfrage an den Server sendet, enthält er eine Autorisierung Header mit den in Base64 kodierten Anmeldedaten.

Beispiel：

Autorisierung: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Der Server dekodiert diesen Header und überprüft, ob der Benutzername und das Passwort gültig sind.

Authentifizierungsmethoden für WordPress REST API

Bei der Arbeit mit dem WordPress REST APIkönnen verschiedene Authentifizierungsmethoden zur Sicherung von Anfragen verwendet werden:

1：Basische Authentifizierung

• Diese Methode wird häufig für Tests und einfache Anwendungen verwendet. Sie senden Ihren WordPress-Benutzernamen und Ihr Passwort in den Headern der Anfrage.
• Plugin-Tipp: Um die Basisauthentifizierung mit WordPress zu verwenden, können Sie die Plugin für die einfache Authentifizierung. Diese Methode wird aufgrund von Sicherheitsbedenken nicht für Produktionsumgebungen empfohlen.

2：Cookie-Authentifizierung

• Die Cookie-Authentifizierung wird verwendet, wenn Sie möchten, dass der aktuell angemeldete Benutzer auf die API zugreifen kann. Wenn sich ein Benutzer bei WordPress anmeldet, wird ein Sitzungscookie erstellt, und die API verwendet dieses Cookie zur Authentifizierung des Benutzers.
• Anwendungsfall: Dies wird häufig für Front-End-JavaScript-Anwendungen verwendet, die auf der gleichen Domain wie die WordPress-Website laufen.

3：OAuth-Authentifizierung

• OAuth ist eine sicherere Methode, die es Anwendungen von Drittanbietern ermöglicht, im Namen von Benutzern auf die WordPress REST API zuzugreifen, ohne deren Passwörter weiterzugeben.
• Beispiel Plugin: Sie können das OAuth 1.0a Server Plugin für WordPress verwenden, um eine OAuth-basierte Authentifizierung zu implementieren.

4：Anwendungskennwörter

• WordPress unterstützt auch Anwendungspasswörter, die eindeutige Passwörter für den API-Zugang sind. Sie können in Ihrem WordPress-Dashboard Anwendungskennwörter generieren, die zur Authentifizierung verwendet werden können.
• Wie man generiert: Gehen Sie zu Ihrem Benutzerprofil in WordPress, scrollen Sie nach unten zum Abschnitt Anwendungspasswörter und erstellen Sie ein neues Passwort.

Maximierung der Entwicklung mit WordPress REST API

Mit der WordPress REST API können Sie leistungsstarke Webanwendungen erstellen, indem Sie mit Ihrer WordPress-Website von außerhalb des WordPress-Dashboards interagieren. Hier erfahren Sie, wie Sie die Entwicklung maximieren können:

1：Benutzerdefinierte Endpunkte: Sie können benutzerdefinierte Endpunkte erstellen, um zusätzliche Daten von Ihrer WordPress-Website zu veröffentlichen, die möglicherweise nicht standardmäßig verfügbar sind.

• Wie man erstellt: Verwenden Sie die register_rest_route() Funktion in Ihrem WordPress-Theme oder -Plugin, um neue Endpunkte hinzuzufügen.

Beispiel:

add_action('rest_api_init', function() {
  register_rest_route('myplugin/v1', '/custom-data/', array(
    'methods' => 'GET',
    'callback' => 'my_custom_data_callback',
  ));
});

function meine_angepassten_daten_callback() {
  return new WP_REST_Response(array('data' => 'Hallo, Welt!'), 200);
}

2：JavaScript Integration: Verwenden Sie JavaScript, um Anfragen an die REST-API zu senden und dynamische, interaktive Benutzererlebnisse zu schaffen. Sie können zum Beispiel eine React- oder Vue.js-Anwendung erstellen, die über die REST-API mit Ihrem WordPress-Backend interagiert.

Praktisches Beispiel: Stellen Sie sich vor, Sie bauen ein benutzerdefiniertes Kommentarsystem, in dem Benutzer Kommentare abgeben können, ohne die Seite neu laden zu müssen, indem sie über JavaScript mit der REST-API interagieren.

Senden von authentifizierten Anfragen mit JavaScript

Um authentifizierte Anfragen mit JavaScript zu senden, müssen Sie die richtigen Anmeldeinformationen oder Token in die Kopfzeilen der Anfrage aufnehmen. Zum Beispiel:

fetch('https://api.example.com/users', {
  Methode: 'GET',
  headers: {
    'Authorization': 'Basic ' + btoa('username:password'),
    'Content-Type': 'application/json'
  }
})
  .then(response => response.json())
  .then(data => console.log(data));

In diesem Beispiel kodiert die Funktion btoa() die Anmeldedaten in Base64 für die primäre Authentifizierung.

Cookie-Authentifizierung

Wenn Sie mit Cookie-Authentifizierung arbeiten, können Sie die Session-Cookies des angemeldeten WordPress-Benutzers für den Zugriff auf die REST-API verwenden. Hier finden Sie ein Beispiel, das Schritt für Schritt erklärt, wie es funktioniert:

1. Benutzer meldet sich an Der Benutzer meldet sich bei Ihrer WordPress-Website an, und WordPress setzt ein Authentifizierungs-Cookie im Browser des Benutzers.
2. Anfragen senden: Wenn Ihr JavaScript-Code die REST-API anfordert, nimmt der Browser das Cookie in die Kopfzeilen der Anfrage auf, und WordPress weiß, welcher Benutzer die Anfrage stellt.

Senden von Anfragen mit der WordPress HTTP API

Sie können auch die WordPress HTTP API um Anfragen von Ihrer WordPress-Website aus zu senden. Die HTTP-API ist eine Reihe von Funktionen, die WordPress für die Interaktion mit REST-APIs bereitstellt.

Beispiel für das Senden einer GET-Anfrage:

$response = wp_remote_get('https://api.example.com/users');
if (is_wp_error($response)) {
  $error_message = $response->get_error_message();
  echo "Etwas ist schief gelaufen: $error_message";
} else {
  $body = wp_remote_retrieve_body($response);
  echo $body;
}

Dieses Beispiel verwendet die Funktion wp_remote_get(), um eine GET-Anfrage an eine externe API zu senden und die Antwort abzurufen.

Zusammenfassung

In diesem Leitfaden behandeln wir:

• Was ist REST API, und wie ermöglicht es die Kommunikation zwischen verschiedenen Systemen?
• So funktioniert die REST API, einschließlich der Art und Weise, wie Anfragen gestellt und bearbeitet werden.
• Authentifizierungsmethodenwie Basisauthentifizierung, Cookie-Authentifizierung, OAuth und Anwendungspasswörter und warum sie so wichtig sind.
• WordPress REST API-Authentifizierung, einschließlich der Verwendung von JavaScript und PHP, um authentifizierte Anfragen zu senden.

FAQ: Häufige Fragen zu REST API und Authentifizierung

1. Kann ich REST API ohne Authentifizierung verwenden?
   • Ja, aber nur für öffentliche Daten. Für alle sensiblen Daten benötigen Sie eine angemessene Authentifizierung.
2. Ist die Basisauthentifizierung sicher?
   • Die Basisauthentifizierung ist für die Produktion nicht sicher, da die Anmeldeinformationen kodiert und nicht verschlüsselt sind. Sie ist besser für Tests oder über HTTPS geeignet.
3. Wofür werden Anwendungskennwörter verwendet?
   • Anwendungspasswörter authentifizieren API-Anfragen, ohne dass Sie Ihr primäres WordPress-Passwort weitergeben müssen. Sie helfen bei der Integration von Anwendungen Dritter.

Nächste Schritte

• Praxis Authentifizierung: Versuchen Sie, verschiedene Authentifizierungsmethoden in einer lokalen WordPress-Website zu implementieren.
• Benutzerdefinierte Endpunkte erstellen: Experimentieren Sie mit der Erstellung benutzerdefinierter Endpunkte in WordPress, um die Funktionalität Ihrer REST-API zu erweitern.
• Integration von JavaScript und PHP: Üben Sie das Senden von Anfragen mit JavaScript (wie fetch) und PHP (unter Verwendung der WordPress HTTP API).
• Verwenden Sie Postman zum Testen: Verwenden Sie Tools wie Postbote um Ihre REST-API-Endpunkte zu testen und das Senden authentifizierter Anfragen zu üben.

Viel Spaß beim Programmieren und erforschen Sie weiter! Die REST-API ist ein mächtiges Werkzeug, und wenn Sie verstehen, wie man es einsetzt, eröffnen sich Ihnen unendlich viele Möglichkeiten in der Webentwicklung.