Ältere PluginsVeraltet

Was ist ein Plugin?

Plugins sind jede Integration zwischen einer Drittanbieterlösung und Stripe, bei der sich ein/e Nutzer/in mit seinen/ihren geheimen API-Schlüsseln authentifizieren muss. Ein Plugin interagiert in der Regel mit Stripe-APIs, indem es entweder API-Aufrufe durchführt oder im Namen seiner Nutzer/innen auf Stripe-API-Ereignisse reagiert. Plugins führen häufig Code aus, der es Stripe ermöglicht, mit anderer Software zu interagieren, zum Beispiel Zahlungen auf WordPress zu akzeptieren. Sie können auch andere Formen annehmen, wie Open-Source-Bibliotheken oder Website-Builder.

Best Practices für ältere Plugins

Befolgen Sie diese Best Practices, um Ihre Nutzer/innen bei der sicheren Verarbeitung auf der Stripe-Plattform ohne Unterbrechung zu unterstützen, wenn unsere API aktualisiert oder geändert wird. Wenn Sie Fragen haben, kontaktieren Sie uns unter plugins@stripe.com.

• Registrieren Sie Ihr Plugin, indem Sie ein Stripe-Konto erstellen oder ein bestehendes Konto verwenden
• Geben Sie mit setAppInfo und registerAppInfo identifizierende Informationen zum Plugin an, damit wir Sie auf mögliche Probleme hinweisen können.
• Legen Sie die Version der Stripe-API in Ihrem Plugin fest, um potenzielle fehlerverursachende Änderungen für Ihre Nutzer/innen zu vermeiden.
• Verwenden Sie die clientseitige Tokenisierung, um Zahlungsdaten sicher im Browser zu erfassen.

Sie können auch einige Schritte unternehmen, um die Qualität Ihres Connectors zu verbessern:

• Fügen Sie das Express Checkout Element hinzu, um Ihren Kundinnen und Kunden mehrere Schaltflächen für Zahlungen mit einem Klick anzubieten, darunter Apple Pay, Google Pay, Link und PayPal.
• Ermöglichen Sie internationalen Nutzer/innen die Verwendung weiterer Zahlungsmethoden neben Kreditkarten.
• Überprüfen Sie, ob Ihre Nutzer/innen HTTPS aktiviert haben, um besser geschützt zu sein.
• Registrieren Sie sich für unsere Mailingliste, um über Änderungen an der Stripe-API auf dem Laufenden zu bleiben.

Plugin identifizieren

Geben Sie identifizierende Informationen zum Plugin an, damit wir Sie kontaktieren können, wenn ein Problem mit Ihrem Connector oder ein kritisches Update der API vorliegt.

Aufrufe der Backend-API

Wenn Sie die APIs zum Erstellen serverseitiger Anfragen nutzen, verwenden Sie setAppInfo mit einem Hash, der die folgenden Optionen enthält:

• name (erforderlich): der Name Ihres Plugins
• partner_id (erforderlich für verifizierte Partner von Stripe, ansonsten optional): Ihre Partner-ID aus dem Abschnitt Partner des Dashboards
• version (optional): die Version Ihres Plugins
• url (optional): die URL für die Website Ihres Plugins mit Ihren Kontaktinformationen

Stripe.set_app_info(
  'MyStripePlugin',
  partner_id: 
'{{PARTNER_ID}}', # Used by Stripe to identify your connector
  version: '1.2.34',
  url: 'https://example.com'
)

Wenn Sie einen Connector erstellen und keine unserer offiziellen Bibliotheken verwenden, setzen Sie den Wert des User-Agent-Headers bei Anfragen an die Stripe-API auf name/version (url).

Beispiel:

User-Agent: WordPress MyStripePlugin/1.2.34 (https://example.com)

Client-Seite/Stripe.js

Nutzen Sie bei Frontend-Bibliotheken, die Stripe.js verwenden, registerAppInfo mit den gleichen Optionen wie bei setAppInfo oben. Mit JavaScript sähe das z. B. so aus:

stripe.registerAppInfo({
  name: "MyOSSLibrary",
  partner_id: 
'{{PARTNER_ID}}',   // Used by Stripe to identify your connector
  version: "1.2.34",
  url: "https://example.com",
});

API-Version festlegen

Ihr Plugin sollte die Funktion setApiVersion verwenden, sodass in jeder Anfrage der HTTP-Header Stripe-Version enthalten ist. Ihre Nutzer/innen verwenden ihre eigenen API-Schlüssel, um auf Stripe zuzugreifen, aber dieser Header wird bei jeder Anfrage mitgeschickt. Wir empfehlen, dass Sie die zuletzt veröffentlichte Version der API verwenden. Die aktuelle API-Version und Details zu unserer Versionierungsrichtlinie finden Sie in der API-Dokumentation.

Stripe.api_key = 
'sk_test_BQokikJOvBiI2HlWgH4olfQ2'
Stripe.api_version = '2022-08-01'

Für neue Nutzer/innen von Stripe gilt automatisch die neueste Version der API. Dieser Header stellt sicher, dass Ihr Connector an eine bestimmte API-Version gebunden ist, damit gelegentliche abwärtsinkompatible Änderungen die Funktionalität Ihres Connectors nicht beeinträchtigen.

Nutzer/innen können ihre API-Version über das Stripe-Dashboard aktualisieren. Wenn Ihr Connector Webhook-Ereignisse nutzt, hängen deren Datenformat und Struktur von der API-Version des Nutzerkontos ab. Sie sollten Ihre Nutzer/innen anweisen, die Version in ihrem Dashboard so einzustellen, dass sie zu Ihrem Plugin passt.

Für Mailingliste registrieren und Updates erhalten

Wir veröffentlichen regelmäßig neue Versionen der Stripe-API mit neuen Funktionen und Fehlerkorrekturen. Sie können die Mailingliste api-announce abonnieren, um über Updates informiert zu werden, von denen Nutzer/innen Ihres Connectors möglicherweise betroffen sind.

Zahlungsangaben sicher erfassen

Nutzerinnen und Nutzer von Stripe müssen für PCI-Konformität sorgen und die entsprechenden Bestimmungen zum sicheren Speichern, Verarbeiten und Übertragen von Kreditkartendaten einhalten. Bei Nichteinhaltung oder potenziellen Verstößen können auf ihre Unternehmen hohe Strafen zukommen. Daher ist es wichtig, sie bei der sicheren Verarbeitung von Daten bei Stripe zu unterstützen.

Da Ihr Connector API-Aufrufe für Nutzer/innen von Stripe vornimmt, müssen Sie Kreditkartendaten sicher mithilfe der clientseitigen Tokenisierung übermitteln. Kund/innen übermitteln ihre persönlichen Daten über einen Webbrowser oder eine App direkt an Stripe. Im Gegenzug wird ein einfaches Token an die Stripe-Nutzer/innen gesendet. So können Ihre Nutzer/innen sicher Kartenangaben erfassen, ohne dass sensible Daten auf den Server gelangen.

Wenn Ihr Connector ein clientseitiges Zahlungsformular im Browser umfasst, empfehlen wir die Verwendung von Stripe.js und Elements oder Checkout:

• Elements bietet vorgefertigte Nutzeroberflächenkomponenten und umfassende Gestaltungsmöglichkeiten für Zahlungsformulare
• Checkout liefert alle Funktionen für den Bezahlvorgang und kann schnell zur Website von Stripe-Nutzer/innen hinzugefügt werden.

Beide Optionen bieten die clientseitige Tokenisierung.

Wenn Ihr Plugin nur in einer Backend-Umgebung betrieben wird, sollten Sie die Nutzer/innen in der Dokumentation Ihres Connectors dazu auffordern, die Zahlungsangaben mit Elements oder Checkout zu tokenisieren. Durch die Tokenisierung können Nutzer/innen von Stripe Zahlungen so sicher wie möglich auf unserer Plattform abwickeln.

Das Express Checkout Element hinzufügen

Das Express Checkout Element bietet Ihnen eine zentrale Integration für die Annahme von Zahlungen über Ein-Klick-Zahlungsschaltflächen, einschließlich Apple Pay, Google Pay, Link oder PayPal.

Mit dem Express Checkout Element können Sie mehrere Schaltflächen gleichzeitig anzeigen. Kundinnen/Kunden werden je nach unterstützter Geräte- und Browserkombination unterschiedliche Zahlungsschaltflächen angezeigt.

Mehrere Zahlungsmethoden ermöglichen

Stripe unterstützt neben Kreditkarten noch andere Zahlungsmethoden. Wir haben einen Leitfaden für Zahlungsmethoden veröffentlicht, in dem die Begriffe, die wichtigsten Überlegungen und die Unterstützung der einzelnen Methoden auf unserer Plattform beschrieben werden.

Mit der Payment Methods API können Ihre Nutzer/innen Zahlungen mit weiteren Zahlungsmethoden erfassen (beispielsweise Alipay, iDEAL, Sofort). Sie können diese Zahlungsmethoden über einen Integrationspfad hinzufügen.

Prüfen, ob HTTPS aktiviert ist

Wenn Ihr Plugin ein Zahlungsformular in einem Webbrowser anzeigt, sollte es prüfen, ob das Formular über HTTPS bereitgestellt wird. Wir verlangen von unseren Nutzer/innen, dass sie HTTPS aktivieren: Sie sollten Ihren Nutzer/innen eine eindeutige Fehlermeldung anzeigen, wenn sie nicht ausreichend geschützt sind.

So können Sie zum Beispiel überprüfen, ob Ihre Nutzer/innen HTTPS aktiviert haben:

# This example uses Sinatra, but the `request` object is provided by Rack
require 'sinatra'

get '/' do
  if !request.https?
    # Present an error to the user
  end
  # ...
end

Wenn Ihr Connector eine Frontend-Komponente hat, prüfen Sie, ob HTTPS vom Browser verwendet wird. Mit JavaScript sähe das z. B. so aus:

// This example checks for HTTPS from the browser
if (window.location.protocol !== "https:") {
  // Present an error to the user
}