API-Produktsets verwalten

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Bündeln Sie ein oder mehrere API-Produkte in einem einzelnen monetarisierten Container, der als API-Produktpaket bezeichnet wird. Eine Beschreibung hierzu finden Sie in den folgenden Abschnitten.

Was ist ein API-Produktset?

Ein API-Produktpaket ist eine Sammlung von API-Produkten, die Entwicklern als Gruppe präsentiert wird und in der Regel mit einem oder mehreren Tarifplänen für die Monetarisierung verknüpft ist. Sie können mehrere API-Produktsets erstellen und jeweils ein oder mehrere API-Produkte angeben. Sie können dieselben API-Produkte in verschiedenen Sets zusammenfassen und mit unterschiedlichen (oder denselben) Tarifen verknüpfen.

Entwickler können ihre Apps für die Verwendung eines API-Produktpakets nur registrieren, wenn sie einen der derzeit gültigen Tarifpakete erwerben. Ein API-Produktpaket ist erst für Entwickler sichtbar, wenn Sie einen Preisplan für das Produktset hinzugefügt und veröffentlicht haben (mit einem Startdatum des aktuellen oder eines zukünftigen Datums), wie unter Preispläne verwalten beschrieben. Nachdem Sie einen Tarifplan hinzugefügt und veröffentlicht haben, können sich Entwickler, die sich in Ihrem Entwicklerportal anmelden, das API-Produktset auswählen und wählen Sie den Preisplan aus. Alternativ können Sie mithilfe der Verwaltungs-API einen Preisplan für einen Entwickler akzeptieren. Weitere Informationen finden Sie unter Veröffentlichte Preispläne über die API erwerben.

Nachdem Sie einem API-Produktpaket ein API-Produkt hinzugefügt haben, müssen Sie möglicherweise Preispunkte für die API-Produkts. Dies ist nur erforderlich, wenn alle der folgenden Bedingungen erfüllt sind:

• Sie richten einen Tarifplan für die Umsatzbeteiligung für das API-Produkt ein.
• Entwickler stellen Drittanbietern die Nutzung von Ressourcen im API-Produkt in Rechnung.
• Es gibt eine minimale oder maximale Beschränkung für den Betrag, den Entwickler in Rechnung stellen können, und Sie möchten um Entwickler über die Einschränkung zu informieren.

Der Mindest- und Höchstpreis werden in den Details zum API-Produktset angezeigt.

Die Seite „Produktpakete“

Rufen Sie wie unten beschrieben die Seite „Produktsets“ auf.

Produktset hinzufügen

So fügen Sie ein API-Produktset hinzu:

1. Klicken Sie auf der Seite Produktsets auf + API-Produktpaket.
2. Geben Sie einen Namen für das API-Produktset ein.

3. Geben Sie den Namen eines API-Produkts in das Feld Produkt hinzufügen ein.

   Wenn Sie den Namen eines API-Produkts eingeben, wird eine Liste der API-Produkte, die den String enthalten, in einer Drop-down-Liste angezeigt. Klicken Sie auf den Namen eines API-Produkts, um es dem Bundle hinzuzufügen. Wiederholen Sie diese Schritte, um weitere API-Produkte hinzuzufügen.

4. Wiederholen Sie Schritt 3, um weitere API-Produktnamen hinzuzufügen.
5. Konfigurieren Sie für jedes API-Produkt, das Sie hinzufügen, die Richtlinie zur Transaktionsaufzeichnung.
6. Klicken Sie auf Produktset speichern.

Produktset bearbeiten

So bearbeiten Sie ein Produktset:

1. Klicken Sie auf der Seite Produktsets in die Zeile des Produktsets, das Sie bearbeiten möchten.

   Das Produktpaket wird angezeigt.

2. Bearbeiten Sie die Felder des Produktsets nach Bedarf.

   Weitere Informationen finden Sie unter Richtlinie für die Transaktionsaufzeichnung konfigurieren.

3. Klicken Sie auf Produktset aktualisieren.

API-Produktsets mit der API verwalten

In den folgenden Abschnitten wird beschrieben, wie Sie API-Produktsets mithilfe der API verwalten.

API-Produktpaket mit der API erstellen

Um ein API-Produktset zu erstellen, senden Sie eine POST-Anfrage an /organizations/{org_name}/monetization-packages Wenn Sie die Anfrage stellen, muss:

• Identifizieren Sie die API-Produkte, die im API-Produktset enthalten sein sollen.
• Geben Sie einen Namen und eine Beschreibung für das API-Produktset an.
• Legen Sie eine Statusanzeige für das API-Produktset fest. Der Statusindikator kann eine der folgenden Optionen enthalten: folgende Werte: CREATED, ACTIVE, INACTIVE. Derzeit ist der von Ihnen angegebene Statusindikator-Wert wird im API-Produktpaket verwaltet, aber zu keinem Zweck verwendet.

Optional können Sie die Organisation angeben.

Unter Eigenschaften der API-Produktpaketkonfiguration finden Sie eine Liste der Optionen, die API verwenden.

Beispiel:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "description": "payment messaging package",
     "displayName": "Payment Messaging Package",
     "name": "Payment Messaging Package",
     "organization": { "id": "{org_name}" },
     "product": [
       { "id": "messaging" },
       { "id": "payment" }
     ],
     "status": "CREATED"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password

Im Folgenden finden Sie ein Beispiel für die Antwort:

{
   "description" : "payment messaging package",
   "displayName" : "Payment Messaging Package",
   "id" : "payment_messaging_package",
   "name" : "Payment Messaging Package",
   "organization" : {
     "id" : "{org_name}",
     "separateInvoiceForFees" : false
   },
   "product" : [ {
     "customAtt1Name" : "user",
     "description" : "Messaging",
     "displayName" : "Messaging",
     "id" : "messaging",
     "name" : "messaging",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }, {
     "customAtt1Name" : "user",
     "description" : "Payment",
     "displayName" : "Payment",
     "id" : "payment",
     "name" : "payment",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }],
   "status" : "CREATED"
 }

Beachten Sie, dass die Antwort zusätzliche Informationen zu den API-Produkten und benutzerdefinierten Attribute, die für diese API-Produkte angegeben sind. (Benutzerdefinierte Attribute werden beim Erstellen eines API-Produkts.) Benutzerdefinierte Attribute für ein API-Produkt können in verschiedenen Tarifplänen berücksichtigt werden. Für Wenn Sie beispielsweise einen Preislistenplan einrichten, bei dem Sie dem Entwickler jede Transaktion in Rechnung stellen, kann den Preis für den Tarif anhand eines benutzerdefinierten Attributs wie der Anzahl der übertragenen Byte festlegen in einer Transaktion.

API-Produkte in einem API-Produktset mithilfe der API verwalten

Sie können ein API-Produkt mithilfe der API aus einem API-Produktset hinzufügen oder daraus löschen. Eine Beschreibung hierzu finden Sie in den folgenden Abschnitten.

API-Produkt einem API-Produktset hinzufügen

Um ein API-Produkt zu einem API-Produktset hinzuzufügen, senden Sie eine POST-Anfrage an organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, Dabei gibt {org_name} den Namen deiner Organisation an, {package_id}. gibt den Namen des API-Produktpakets an und {product_id} die ID der API. Produkt.

Beispiel:

$ curl -H "Accept:application/json" -X POST -d \
'{}'\
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API-Produkt einem API-Produktset mit API hinzufügen produktspezifische Tarifpläne

So fügen Sie ein API-Produkt zu einem API-Produktset mit einem oder mehreren API-produktspezifischen Tarifen hinzu: (Preisliste oder Umsatzbeteiligung) festgelegt haben, senden Sie eine POST-Anforderung an organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, Dabei gibt {org_name} den Namen deiner Organisation an, {package_id}. gibt den Namen des API-Produktpakets an und {product_id} die ID der API. Produkt.

Sie müssen die Preisplandetails für das neue API-Produkt im Anfragetext übergeben. Mit Ausnahme von dem Array ratePlanRates entsprechen, müssen die Preisplanwerte mit denen für alle angegebenen anderen API-Produkten. Weitere Informationen zu den Preisplanattributen, die definiert werden können, finden Sie unter Konfigurationsattribute für Preispläne.

Beispiel:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [ 
        {
            "id": "mypackage_rateplan1",
            "ratePlanDetails": [
                {
                    "currency": {
                        "id": "usd"
                    },
                    "duration": 1,
                    "durationType": "MONTH",
                    "meteringType": "UNIT",
                    "organization" : {
                        "id": "{org_name}",
                    "paymentDueDays": "30",
                    "ratePlanRates": [
                        {
                            "rate": "1.99",
                            "startUnit": "0",
                            "type": "RATECARD"
                        }
                    ],
                    "ratingParameter": "VOLUME",
                    "type": "RATECARD"
                }
            ]
        }
    ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API-Produkt aus einem API-Produktset löschen

Um ein API-Produkt aus einem API-Produktset zu löschen, senden Sie eine DELETE-Anfrage an die organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, Dabei gibt {org_name} den Namen deiner Organisation an, {package_id}. gibt den Namen des API-Produktpakets an und {product_id} die ID der API. Produkt.

Beispiel:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API-Produktsets mit der API ansehen

Sie können ein bestimmtes API-Produktset oder alle API-Produktsets in einer Organisation abrufen. Sie können auch API-Produktpakete mit Transaktionen in einem bestimmten Zeitraum abrufen, d. h. nur Pakete für welche Nutzer Anwendungen aufrufen, die innerhalb eines bestimmten Start- und Endwerts auf APIs in diesen Paketen zugreifen Datum.

Bestimmtes API-Produktset ansehen:Um ein bestimmtes API-Produktset abzurufen, senden Sie eine GET-Anfrage. nach /organizations/{org_name}/monetization-packages/{package_id}, wobei {package_id} steht für die Identifizierung des API-Produktpakets. Die ID wird im wenn Sie das API-Produktset erstellen). Beispiel:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment_messaging_package" \
-u email:password

Alle API-Produktsets ansehen:Um alle API-Produktsets einer Organisation abzurufen, geben Sie eine GET-Anfrage aus. Anfrage an /organizations/{org_name}/monetization-packages. Beispiel:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password

Sie können die folgenden Abfrageparameter übergeben, um die Ergebnisse zu filtern:

Die Antwort auf die Anzeige aller API-Produktsets in einer Organisation sollte wie folgt aussehen (nur ein Teil der Antwort wird angezeigt):

{
  "monetizationPackage" : [ {
    "description" : "payment messaging package",
    "displayName" : "Payment Messaging Package",
    "id" : "payment_messaging_package",
    "name" : "Payment Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "Communications",
    "displayName" : "Communications",
    "id" : "communications",
    "name" : "Communications",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "Payment",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  } ],
  "totalRecords" : 3
}

API-Produktsets mit Transaktionen ansehen:So rufen Sie API-Produktsets mit Transaktionen in einem senden Sie eine GET-Anfrage an /organizations/{org_name}/packages-with-transactions Wenn Sie die Anfrage stellen, müssen Sie als Suchparameter ein Start- und ein Enddatum für den Zeitraum angeben. Für Mit der folgenden Anfrage werden beispielsweise API-Produktpakete mit Transaktionen des Monats August 2013.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/packages-with-transactions?START_DATE=2013-08-01&END_DATE=2013-08-31" \
-u email:password

Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):

{
  "monetizationPackage" : [ {
    "description" : "Payment Package",
    "displayName" : "Payment Package",
    "id" : "payment_package",
    "name" : "Payment Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "payment api product",
      "displayName" : "payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "messaging package",
    "displayName" : "Messaging Package",
    "id" : "messaging_package",
    "name" : "Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "messaging api product",
      "displayName" : "messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  },
     ...
  } ]
}

Von einem Entwickler oder Unternehmen akzeptierte API-Produktpakete ansehen, die die API verwenden

Mit einer GET-Anfrage die von einem bestimmten Entwickler oder Unternehmen akzeptierten API-Produktpakete ansehen an die folgenden APIs:

• /organizations/{org_name}/developers/{developer_id}/monetization-packages, wobei {developer_id} ist die ID (E-Mail-Adresse) des Entwicklers.
• /organizations/{org_name}/companies/{company_id}/monetization-packages, wobei {company_id} ist die ID des Unternehmens.

Wenn Sie die Anfrage senden, können Sie optional die folgenden Abfrageparameter angeben:

Mit der folgenden Anfrage werden beispielsweise alle API-Produktpakete abgerufen, die von einem bestimmten Entwickler:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev1@myorg.com/monetization-packages" \
-u email:password

Die folgende Anfrage ruft nur aktive API-Pakete ab, die von einem bestimmten Unternehmen akzeptiert wurden:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/myCompany/monetization-packages?current=true" \
-u email:password

API-Produktpaket über die API löschen

Sie können ein API-Produktpaket nur löschen, wenn dafür keine Preispläne definiert sind.

Wenn Sie ein API-Produktset löschen möchten, für das keine Preispläne definiert sind, senden Sie eine DELETE-Anfrage an organizations/{org_name}/monetization-packages/{package_id}, Dabei gibt {org_name} den Namen deiner Organisation an. und {package_id} den Namen des API-Produktsets angibt.

Beispiel:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}" \
-u email:password

Konfigurationseigenschaften des API-Produktpakets für die API

Die folgenden Konfigurationsoptionen für API-Produktsets sind für die API verfügbar: