Tutorial: Vorgehensweise zum Vermarkten eines API-Produkts

Vorbereitende Schritte

Info zu diesem Tutorial

IBM® API Connect enthält eine Abonnement-Abrechnungsfunktion, die es API-Anbietern ermöglicht, Preispläne in ihren API-Produkten zu definieren und ihre API-Angebote zu monetarisieren. Wenn ein Produkt einen Preistarif enthält, müssen API-Konsumenten ihre Zahlungsinformationen in das eingeben, bevor sie diesen Plan abonnieren können. API Connect unterstützt die Integration mit Stripe Subscription Billing, einem unabhängigen Cloud-Dienst, der monetisierte Produktpläne, Kunden, deren Zahlungsinformationen und deren Abonnementverlauf verwaltet, um monatliche Rechnungen zu erstellen und Kunden automatisch zu belasten. Mit dieser Integration dient Stripe als Abonnementabrechnungssystem und zugleich als Zahlungsverarbeitungssystem.

Richten Sie Ihre Rechnungsressource ein

Führen Sie die folgenden Schritte aus, um eine Integrationsressource für die Stripe-Abrechnung für Ihre Provider-Organisation zu erstellen.

1. Melden Sie sich bei API Manager an.
2. Klicken Sie auf der Startseite auf die Kachel Ressourcen verwalten.
   
3. Führen Sie auf der Seite Ressourcen die folgenden Aufgaben aus.
   1. Wählen Sie im linken Bereich die Option Abrechnung.
   2. Klicken Sie im rechten Bereich auf Hinzufügen.
      

      Die Seite "Add billing integration page for Stripe integration" wird angezeigt.

4. Führen Sie auf der Seite Abrechnungsintegration hinzufügen die folgenden Aufgaben aus.
   1. Geben Sie in das Feld Titel den Titel Ihrer Rechnungsintegration ein. Zum Beispiel My Stripe Billing.
      Hinweis: Das Feld Name wird auf der Grundlage des von Ihnen eingegebenen Titels automatisch ausgefüllt.
   2. Geben Sie in das Feld Veröffentlichbarer Schlüssel den Testschlüssel für Ihr Stripe-Konto ein.
   3. Geben Sie in das Feld Geheimschlüssel den Testschlüssel für Ihr Stripe-Konto ein.
      Tipp: Wenn Sie noch kein Stripe-Konto haben, können Sie hier eines erstellen: https://dashboard.stripe.com/register. In Ihrem Stripe-Dashboard finden Sie Ihre Test-API-Schlüssel. Für weitere Informationen siehe https://dashboard.stripe.com/apikeys.
      Hinweis : Jedes Stripe-Konto wird mit zwei Sätzen von API-Schlüsseln geliefert, einem für Testzwecke und einem für die Produktion. Jeder Satz von API-Schlüsseln hat einen bestimmten Namensbereich für Stripe-Objekte. Test-API-Schlüssel können keine Objekte erkennen, die von Produktions-API-Schlüsseln erstellt wurden, und umgekehrt. Sie können die API-Schlüssel einer Ihrer Rechnungsintegrationen nicht mit den Schlüsseln eines anderen Kontos austauschen oder Ihre Test- und Produktionsschlüssel vertauschen, da dies API Connect daran hindern würde, die Stripe-Objekte aufzulösen, die mit den alten Schlüsseln erstellt wurden. In diesem Tutorial sollten Sie Ihre Stripe-Test-API-Schlüssel verwenden.
   
5. Klicken Sie auf Hinzufügen, um Ihre Abrechnungsintegrationsressource zu erstellen. Die Integration Meine Stripe-Abrechnung wird nun als Abrechnungsressource angezeigt.
   

Stripe-Test-Katalog konfigurieren

Um vermarktete Produktionspläne veröffentlichen zu können, müssen Sie eine Abrechnungsintegrationsressource zu Ihrem Katalog hinzufügen. Während dieser Aktivität erstellen Sie einen neuen Katalog mit dem Namen "stripe-test", sodass Sie den Katalog am Ende des Tutorials löschen können, wenn Sie möchten.

1. Klicken Sie im API-Manager auf das Symbol Verwalten in der seitlichen Navigationsleiste.
2. Klicken Sie auf Hinzufügen > Katalog erstellen und erstellen Sie einen neuen Katalog namens stripe-test.
3. Klicken Sie auf die Katalogkachel stripe-test und klicken Sie dann auf die Registerkarte Katalogeinstellungen. Wählen Sie Gateway-Dienste aus und stellen Sie sicher, dass der Katalog so konfiguriert ist, dass er entweder DataPower® Gateway (v5 compatible) oder DataPower API Gateway oder beide verwendet. Wählen Sie dann "Portal" und erstellen Sie ein Entwicklerportal. Wenn Sie nicht sicher sind, wie Sie diese Einstellungen konfigurieren können, lesen Sie bitte den Abschnitt Erstellen und Konfigurieren von Katalogen.
4. Um die Rechnungsintegrationsressource zum Katalog hinzuzufügen, wählen Sie "Rechnungsstellung" aus und klicken Sie dann auf "Bearbeiten ".
   
5. Wählen Sie die Ressource Meine Stripe-Abrechnung aus, die Sie zuvor erstellt haben, und klicken Sie auf Speichern.
   
   "My Stripe Billing" ist jetzt als Abrechnungsintegrationsressource für den Katalog "stripe-test" aufgeführt.
   

Aktivieren Sie die Zahlungsmethode "Stripe" im Entwicklerportal

Damit API-Verbraucher Produkte mit kostenpflichtigen Plänen abonnieren können, müssen Sie die Stripe-Zahlungsmethode im Entwicklerportal für den stripe-test-Katalog konfigurieren.

1. Melden Sie sich als Administrator beim Entwicklerportal an.
2. Wenn das Administrator-Dashboard nicht angezeigt wird, klicken Sie auf Verwalten, um es anzuzeigen.
3. Klicken Sie im Administrator-Dashboard auf "Erweitern ". Die Registerkarte Liste für die Seite Erweitern wird geöffnet und die Liste der installierten Module wird angezeigt.
4. Geben Sie Stripe in den Suchfilter ein, wählen Sie APIC-Vermarktung - Stripe-Integration aus und klicken Sie auf Aktivieren.
   
   Die Standardeinstellungen für das APIC Monetization Stripe Integration-Modul sind jetzt aktiviert und Sie müssen diese Einstellungen jetzt bearbeiten.
5. Klicken Sie auf Konfiguration > System > IBM API Connect Abrechnung.
6. Ändern Sie die Abrechnungsprovidermodulzuordnung in der Dropdown-Liste, sodass APIC Monetization Stripe Integration (ibm_stripe_payment_method) die neue Methode ist und klicken Sie auf Konfiguration speichern.
   
7. Klicken Sie auf Konfiguration > System > IBM APIC Stripe-Integration und geben Sie die gleichen Stripe-Test-API-Zugangsdaten ein, die Sie für die Integrationsressource My Stripe Billing in Schritt 4 von Einrichten Ihrer Abrechnungsressource eingegeben haben. Klicken Sie dann auf "Konfiguration speichern ".
   
   Die Stripe-Zahlungsmethode ist jetzt im Entwicklerportal konfiguriert.

Vermarktetes Produkt erstellen und veröffentlichen

Erstellen Sie ein Produkt, das einen Preisplan enthält, und veröffentlichen Sie das Produkt im Entwicklerportal.

1. Zuerst müssen Sie eine Test-API herunterladen, die Sie mit Ihrem Produkt verwenden können:
   • Wenn Ihr Katalog für Streifen-Tests eine DataPower Gateway (v5 compatible) verwendet, laden Sie die findbranch.txt datei auf Ihr lokales Dateisystem herunter. Benennen Sie diese Datei in findbranch.yaml um.
   • Wenn Ihr Katalog für Streifen-Tests eine DataPower API Gateway verwendet, laden Sie die findbranch_v6.txt datei auf Ihr lokales Dateisystem herunter. Benennen Sie diese Datei in findbranch.yaml um.
   Oder wenn Sie es bevorzugen, können Sie eine Ihrer eigenen APIs verwenden.
2. Um die API in den API-Manager zu importieren, klicken Sie in der seitlichen Navigationsleiste auf das Symbol Develop und dann auf Add > API (aus REST, GraphQL oder SOAP).
   
3. Stellen Sie sicher, dass OpenAPI 2.0 ausgewählt ist und wählen Sie dann Vorhandenes OpenAPI im Abschnitt Import aus. Klicken Sie dann auf Weiter.
   
4. Klicken Sie auf Drag and drop files here or click to upload, und wählen Sie die Datei findbranch.yaml auf Ihrem lokalen Dateisystem aus, um sie hochzuladen. Klicken Sie dann auf Weiter.
   
5. Lassen Sie die Option API aktivieren nicht aktiviert, da Sie die API aktivieren, wenn Sie das monetarisierte Produkt später in diesem Abschnitt veröffentlichen. Klicken Sie auf Weiter, um den Vorgang fortzusetzen.
6. Die Seite Zusammenfassung wird angezeigt und Sie sehen, dass die API-Definition generiert wurde.
   
7. Klicken Sie auf API bearbeiten, um Ihre generierte API-Definition zu sehen, und klicken Sie dann auf das Symbol Entwickeln in der seitlichen Navigationsleiste, um mit der Erstellung eines monetarisierten Produkts fortzufahren. Die FindBranch API sollte nun in Ihrer Liste der APIs angezeigt werden - falls nicht, klicken Sie einfach auf das Symbol Refresh, um Ihren Browser zu aktualisieren.
8. Klicken Sie auf Hinzufügen > Produkt
   
9. Wählen Sie "Neues Produkt" aus und klicken Sie auf "Weiter ".
10. Geben Sie FindBranches in das Feld "Titel" ein und klicken Sie auf "Weiter ".
    
11. Wählen Sie die FindBranch-API, die Sie importiert haben, oder Ihre eigene API aus und klicken Sie auf Weiter.
12. Akzeptieren Sie die Standardwerte für Pläne und klicken Sie auf Weiter. Sie fügen später einen Tarif hinzu.
    
13. Akzeptieren Sie auch die Standardwerte für "Veröffentlichen ", "Sichtbarkeit " und "Abonnierbarkeit " und klicken Sie auf "Weiter ".
    
14. Die Seite Zusammenfassung wird angezeigt und bestätigt, dass das neue Produkt erstellt wurde.
    
15. Klicken Sie auf Produkt bearbeiten, um die Konfiguration fortzusetzen.
16. Klicken Sie bei ausgewählter Registerkarte "Design" im Navigationsmenü auf "Pläne ".
    
17. Wählen Sie im Abschnitt Billing-Integration die Option my-stripe-billing als Abrechnungsintegrationsressource aus.
18. Klicken Sie im Abschnitt Pläne auf Hinzufügen , um einen neuen Plan mit Preisgestaltung zu erstellen.
19. Geben Sie einen Titel für den neuen Plan ein, zum Beispiel Gold, aber lassen Sie das Kontrollkästchen Genehmigung nicht ausgewählt.
20. Ändern Sie die Umschaltfläche auf Ein für Planpreisgestaltung und der Definitionsabschnitt Planpreisgestaltung wird angezeigt.
21. Wählen Sie Include free trial days(kostenlose Testtage einschließen) aus und lassen Sie den Standardwert 1 für die Anzahl der Testtage, dass ein Subskribent den Plan ohne Gebühren verwenden kann, nach dem der Abrechnungszyklus beginnt.
22. Lassen Sie auch hier die Standardeinstellungen USD - US Dollar für "Währung" und 10 für den "Preis pro Monat ", der dem Abonnenten in Rechnung gestellt wird.
    
23. Ändern Sie im Abschnitt Planratenbegrenzungen die Aufrufe auf 1000 pro Stunde, um diesen Plan aus dem Standardplan zu unterscheiden. Klicken Sie auf Speichern, um den neuen Preistarif zu speichern.
    
24. Nun können Sie das monetarisierte Produkt im Strip-Test-Katalog veröffentlichen, indem Sie auf das Symbol Optionen für das Produkt und dann auf Veröffentlichen klicken.
    
25. Stellen Sie sicher, dass der Katalog stripe-test ausgewählt ist, und klicken Sie dann auf Veröffentlichen.
26. Sie können überprüfen, ob das FindBranches Produkt nun veröffentlicht ist, indem Sie in der seitlichen Navigationsleiste auf das Symbol Verwalten klicken und die Kachel " Streifentest" auswählen. Das Produkt FindBranches wird nun auf der Registerkarte Produkte aufgelistet.
    
    Tipp: Denken Sie daran, auf das Symbol Aktualisieren zu klicken, wenn das Produkt nicht angezeigt wird.

Veröffentlichung in Ihrem Stripe-Account überprüfen

Sie können überprüfen, ob die Produktpläne in Ihrem Stripe-Account veröffentlicht wurden, indem Sie die folgenden Schritte ausführen.

1. Melden Sie sich bei Ihrem Stripe-Testaccount an.
2. Wählen Sie in der Entwicklernavigation "Events" aus.
3. Überprüfen Sie, ob Ereignisse erstellt wurden, als Sie die Produktpläne veröffentlicht haben.

Das monetarisierte Produkt im Entwicklerportal anzeigen

Sie können überprüfen, ob das monetarisierte Produkt jetzt im Entwicklerportal sichtbar ist, indem Sie die folgenden Schritte ausführen.

1. Öffnen Sie das Entwicklerportal für den Streifen-Testkatalog in Ihrem Webbrowser. Sie müssen sich nicht anmelden.
2. Das Produkt FindBranches sollte auf der Homepage angezeigt werden.
   
3. Klicken Sie auf die Kachel FindBranches, und die Pläne werden angezeigt, wobei sowohl die Standard-als auch die Gold-Pläne angezeigt werden. Sie können die Preisinformationen für den Gold-Plan anzeigen. Wenn Sie den Mauszeiger über den Text 2 ratenbegrenzungen bewegen, können Sie die Details der Ratenbegrenzung anzeigen. Ein API-Kunde kann diesen kostenpflichtigen Plan jetzt abonnieren.
   

Die Themen dieses Tutorials

In diesem Tutorial haben Sie erfolgreich ein monetisiertes Produkt erstellt und veröffentlicht, das für API-Konsumentenabonnements bereit ist. Sie haben die folgenden Aktivitäten abgeschlossen:

• Eine Integrationsressource für die Stripe-Abrechnung erstellt.
• Einen stripe-test-Katalog konfiguriert.
• Aktivierte Stripe im Entwicklerportal.
• Ein vermarktetes Produkt erstellt und veröffentlicht.
• Die Veröffentlichung in Ihrem Stripe-Account überprüft.
• Das monetarisierte Produkt im Entwicklerportal angesehen.