Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen info
In den folgenden Abschnitten wird das Organisationsprofil vorgestellt und beschrieben, wie Sie es über die Benutzeroberfläche und die API verwalten können.
Organisationsprofil
Im Rahmen der Ersteinrichtung der Monetarisierung richtet das Apigee Edge-Konfigurationsteam Ihr Organisationsprofil ein.
Sie müssen das Organisationsprofil bearbeiten, um Informationen zu Ihrer Organisation hinzuzufügen oder zu aktualisieren. Möglicherweise müssen Sie beispielsweise den Abrechnungstyp, die Währungseinstellungen oder das Steuermodell aktualisieren.
Konfigurieren Sie grundlegende Informationen zu Ihrer Organisation, darunter:
- Name, Adresse und Land, in dem die Organisation tätig ist
- Abrechnungstyp (Prepaid, Postpaid oder beides), wie unter Abrechnungstyp beschrieben
- Abrechnungszeitraum (anteilig oder Kalendermonat)
- Basiswährung
- Von Ihrer Organisation verwendetes Steuermodell
Sie können Ihr Organisationsprofil über die Benutzeroberfläche und die API verwalten, wie in den folgenden Abschnitten beschrieben.
Seite „Organisationsprofil“ aufrufen
Rufen Sie die Seite „Organisationsprofil“ wie unten beschrieben auf.
Edge
So greifen Sie über die Edge-Benutzeroberfläche auf die Seite „Organisationsprofil“ zu:
- Melden Sie sich unter apigee.com/edge an.
- Wählen Sie in der linken Navigationsleiste Veröffentlichen > Monetarisierung > Organisationsprofil aus.
Die Seite „Organisationsprofil“ wird angezeigt.

Wie in der Abbildung hervorgehoben, können Sie auf der Seite „Organisationsprofil“ Folgendes tun:
- Aktuelle Einstellungen des Organisationsprofils ansehen
- Bearbeiten Sie die Einstellungen des Organisationsprofils, einschließlich:
- Name und Informationen
- Steuern und Währung
- Nutzungsbedingungen, wie unter Nutzungsbedingungen verwalten beschrieben
Classic Edge (Private Cloud)
So greifen Sie über die Classic Edge-Benutzeroberfläche auf die Seite „Organisationsprofil“ zu:
- Melden Sie sich bei
http://ms-ip:9000an, wobei ms-ip die IP-Adresse oder der DNS-Name des Management Server-Knotens ist. - Wählen Sie in der oberen Navigationsleiste Admin > Organisationsprofil aus.
Die Seite „Organisationsprofil“ wird angezeigt.

Auf der Seite „Organisationsprofil“ haben Sie folgende Möglichkeiten:
- Aktuelle Einstellungen des Organisationsprofils ansehen
- Bearbeiten Sie die Einstellungen des Organisationsprofils, einschließlich:
- Name und Informationen
- Steuern und Währung
- Nutzungsbedingungen, wie unter Nutzungsbedingungen verwalten beschrieben
Organisationsprofil über die Benutzeroberfläche bearbeiten
So bearbeiten Sie das Organisationsprofil über die Benutzeroberfläche:
- Rufen Sie die Seite „Organisationsprofil“ auf.
- Klicken Sie auf Bearbeiten.
- Bearbeiten Sie unter Name und Informationen den Namen der Organisation und das Land, in dem sie tätig ist.
- Bearbeiten Sie unter Steuern und Währung die folgenden Felder:
Feld Beschreibung Steuermodell Hinweis:Gilt nur, wenn Sie Tarife für die Umsatzbeteiligung eingerichtet haben und Abrechnungsdokumente erstellen möchten.
Steuermodell für Tarife mit Umsatzbeteiligung, das den Typ der erforderlichen Abrechnungsdokumente angibt.
Gültige Werte sind:
- Offenlegung: Der API-Anbieter fungiert als determinierter Agent des Entwicklers. Die vom Endnutzer erhobenen Bruttoeinnahmen (einschließlich Umsatzsteuer) werden an den Entwickler weitergeleitet. Die Provision des API-Anbieters wird vom Entwickler in Form einer Provisionsrechnung erhoben. Der API-Anbieter kümmert sich nicht um die vom Endnutzer erhobene Umsatzsteuer. Es liegt in der Verantwortung des Entwicklers, die Umsatzsteuer zu melden.
- Nicht determiniert: Der API-Anbieter fungiert als nicht determinierter Agent des Entwicklers, zieht die von den Endnutzern erhobene Steuer ab und zahlt sie an die lokalen Steuerbehörden. Der Entwickler stellt dem API-Anbieter den Nettoumsatzanteil in Rechnung, der ihm zusteht (abzüglich Umsatzsteuer und Provision des API-Anbieters).
- Hybrid: Der API-Anbieter fungiert als determinierter Agent des Entwicklers. Der API-Anbieter zahlt jedoch die von seinen Abonnenten erhobene Umsatzsteuer im Namen des Entwicklers an die lokalen Steuerbehörden. Der API-Anbieter leitet den verbleibenden Umsatz an den Entwickler weiter und stellt dann die Provisionsgebühren in Rechnung.
Währung Währungen, die von Ihrer Organisation unterstützt werden. Bei Tarifen mit Umsatzbeteiligung, Preisliste und Gebühren wird die Standardwährung für Ihren Tarif verwendet. Wenn Sie eine Ratenkarte oder einen Plan mit Gebühren erstellen, können Sie die Währung ändern, indem Sie sie aus einer Liste unterstützter Währungen auswählen. Optional können Sie für jede Währung den Mindestbetrag festlegen, den App-Entwickler ihrem Prepaid-Guthaben hinzufügen können.
So fügen Sie eine Währung hinzu:
- Klicken Sie auf Währung hinzufügen.
- Wählen Sie im Feld Currency (Währung) eine Währung aus dem Drop-down-Menü aus.
- Optional können Sie im Feld Mindestbetrag für Aufladung den Mindestbetrag festlegen, den App-Entwickler ihrem Prepaid-Guthaben in der angegebenen Währung hinzufügen können.
- Klicken Sie auf Hinzufügen.
- Wenn Sie die Währung als Standardwährung festlegen möchten, klicken Sie auf das zugehörige Optionsfeld.
- Wiederholen Sie die Schritte, um weitere Währungen hinzuzufügen.
Wenn Sie eine Währung löschen möchten, bewegen Sie den Mauszeiger auf die Währung und klicken Sie auf
. - Nutzungsbedingungen verwalten, wie unter Nutzungsbedingungen über die Benutzeroberfläche verwalten beschrieben.
- Klicken Sie auf Speichern.
Organisationsprofil mit der API verwalten
Verwalten Sie das Organisationsprofil mit der API, wie in den folgenden Abschnitten beschrieben.
Organisationsprofil mit der API aufrufen
Rufen Sie Ihr Organisationsprofil auf, indem Sie eine GET-Anfrage an /mint/organizations/{org_name} senden. Beispiel:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
-H "Accept: application/json" \
-u email:password
Im Folgenden finden Sie ein Beispiel für die Antwort: Weitere Informationen zu den angezeigten Optionen finden Sie unter Konfigurationseigenschaften für Organisationsprofile für die API.
{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "{org_name}" "issueNettingStmt" : false, "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "myorg", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : true, "status" : "ACTIVE", "supportedBillingType" : "PREPAID", "taxModel" : "UNDISCLOSED", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }
Organisationsprofil mit der API bearbeiten
Bearbeiten Sie das Organisationsprofil, indem Sie eine PUT-Anfrage an /mint/organizations/{org_name} senden. Wenn Sie das Organisationsprofil bearbeiten, müssen Sie alle Attribute des Organisationsprofils angeben, nicht nur die Attribute, die Sie bearbeiten.
Wenn Sie die Standardwährung für die Organisation bearbeiten möchten, legen Sie den Wert currency auf den ISO 4217-Währungscode der unterstützten Währung fest, die Sie als Standardwährung festlegen möchten.
Mit dem folgenden API-Aufruf wird beispielsweise die currency auf USD und die Einstellung für das Steuermodell auf HYBRID aktualisiert (die aktualisierten Felder sind im Beispiel hervorgehoben). Weitere Informationen zu den angezeigten Optionen finden Sie unter Konfigurationsattribute für das Organisationsprofil für die API.
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
-H "Content-Type: application/json" \
-d '{
"address" : [ {
"address1" : "Test address”,
"city" : "Test City",
"country" : "US",
"id" : "corp-address",
"isPrimary" : true,
"state" : "CA",
"zip" : "54321"
} ],
"approveTrusted" : false,
"approveUntrusted" : false,
"billingCycle" : "CALENDAR_MONTH",
"country" : "US",
"currency" : "USD",
"description" : "Test organization",
"hasBillingAdjustment" : true,
"hasBroker" : false,
"hasSelfBilling" : false,
"hasSeparateInvoiceForProduct" : false,
"id" : "myorg",
"issueNettingStmt" : false,
"logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
"name" : "{org_name}",
"nettingStmtPerCurrency" : false,
"regNo" : "RegNo-1234-myorg",
"selfBillingAsExchOrg" : false,
"selfBillingForAllDev" : false,
"separateInvoiceForFees" : false,
"status" : "ACTIVE",
"supportedBillingType" : "POSTPAID",
"taxModel" : "HYBRID",
"taxRegNo" : "TaxRegNo-1234-myorg",
"timezone" : "UTC"
}' \
-u email:password
Prepaid- und Postpaid-Abrechnungstypen mit der API konfigurieren
Für Entwicklerkonten können die folgenden Abrechnungstypen konfiguriert werden: Prepaid, Postpaid oder beides.
Bei Prepaid-Konten bezahlen Entwickler im Voraus für die Nutzung Ihrer APIs. Die Verwendung des API-Produkts wird vom Prepaid-Guthaben des Entwicklers abgezogen, das über einen integrierten Zahlungsdienstleister verwaltet wird. Der Entwickler muss über ein Prepaidguthaben verfügen, das zum Kauf der APIs ausreicht.
Bei Konten mit nachträglicher Zahlung erhalten Entwickler am Monatsende eine monatliche Rechnung. Der Entwickler bezahlt für die Nutzung von API-Produkten basierend auf den Zahlungsbedingungen, die in den auf der Rechnung enthaltenen Tarifen angegeben sind.
Wenn Sie die Abrechnungstypen „Prepaid“ und „Postpaid“ für Ihre Organisation konfigurieren möchten, legen Sie die supportedBillingType-Eigenschaft auf einen der folgenden Werte fest, um anzugeben, welche Abrechnungstypen gültig sind: PREPAID, POSTPAID oder BOTH. Wenn Sie den Wert auf BOTH festlegen, ist der Standardwert PREPAID, wenn Sie einen App-Entwickler oder ein Unternehmen hinzufügen. In diesem Fall können Sie den Abrechnungstyp für ein Unternehmen oder einen App-Entwickler explizit über die API festlegen, wie unter Unternehmen und App-Entwickler verwalten beschrieben.
Beispiel:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
-H "Content-Type: application/json" \
-d '{
"address" : [ {
"address1" : "Test address",
"city" : "Test City",
"country" : "US",
"id" : "corp-address",
"isPrimary" : true,
"state" : "CA",
"zip" : "54321"
} ],
"approveTrusted" : false,
"approveUntrusted" : false,
"billingCycle" : "CALENDAR_MONTH",
"country" : "US",
"currency" : "USD",
"description" : "Test organization",
"hasBillingAdjustment" : true,
"hasBroker" : false,
"hasSelfBilling" : false,
"hasSeparateInvoiceForProduct" : false,
"id" : "myorg",
"issueNettingStmt" : false,
"logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
"name" : "{org_name}",
"nettingStmtPerCurrency" : false,
"regNo" : "RegNo-1234-myorg",
"selfBillingAsExchOrg" : false,
"selfBillingForAllDev" : false,
"separateInvoiceForFees" : false,
"status" : "ACTIVE",
"supportedBillingType" : "POSTPAID",
"taxModel" : "HYBRID",
"taxRegNo" : "TaxRegNo-1234-myorg",
"timezone" : "UTC"
}' \
-u email:password
Abrechnungszeitraum mit der API konfigurieren
Wenn Sie den Abrechnungszeitraum für Ihre Organisation konfigurieren möchten, legen Sie für das Attribut billingCycle einen der folgenden Werte fest:
PRORATED: Die Abrechnung erfolgt auf Grundlage der Anzahl der Tage, an denen ein API-Produkt in einem Kalendermonat verwendet wird.CALENDAR_MONTH: Die Abrechnung erfolgt monatlich.
Beispiel:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
-H "Content-Type: application/json" \
-d '{
"address" : [ {
"address1" : "Test address",
"city" : "Test City",
"country" : "US",
"id" : "corp-address",
"isPrimary" : true,
"state" : "CA",
"zip" : "54321"
} ],
"approveTrusted" : false,
"approveUntrusted" : false,
"billingCycle" : "CALENDAR_MONTH",
"country" : "US",
"currency" : "USD",
"description" : "Test organization",
"hasBillingAdjustment" : true,
"hasBroker" : false,
"hasSelfBilling" : false,
"hasSeparateInvoiceForProduct" : false,
"id" : "myorg",
"issueNettingStmt" : false,
"logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
"name" : "{org_name}",
"nettingStmtPerCurrency" : false,
"regNo" : "RegNo-1234-myorg",
"selfBillingAsExchOrg" : false,
"selfBillingForAllDev" : false,
"separateInvoiceForFees" : false,
"status" : "ACTIVE",
"supportedBillingType" : "POSTPAID",
"taxModel" : "HYBRID",
"taxRegNo" : "TaxRegNo-1234-myorg",
"timezone" : "UTC"
}' \
-u email:password
Konfigurationseigenschaften für das Unternehmensprofil für die API
Mit dem Organisationsprofil können Sie die folgenden Konfigurationseigenschaften über die API festlegen.
| Name | Beschreibung | Standard | Erforderlich? |
|---|---|---|---|
address |
Adresse der Organisation, die Straße, Ort, Bundesland, Postleitzahl, Land und einen Hinweis darauf enthalten kann, ob es sich um die primäre Adresse der Organisation handelt. |
– | Nein |
approveTrusted |
Dieses Flag wird nicht verwendet. |
– | Nein |
approveUntrusted |
Dieses Flag wird nicht verwendet. |
– | Nein |
billingCycle |
Zeitraum des Abrechnungszeitraums. Der Wert kann einer der folgenden sein:
Weitere Informationen finden Sie unter Abrechnungszeitraum mit der API konfigurieren. |
– | Ja |
country |
ISO 3166-2-Code für das Land, in dem die Organisation tätig ist, z. B. BR für Brasilien. |
– | Ja |
currency |
ISO 4217-Code für die „Basis“- oder Abrechnungswährung, die von der Organisation verwendet wird (z. B. USD für US-Dollar). Bei Plänen mit Umsatzbeteiligung: Die angegebene Währung wird für Ihren Plan verwendet. Für Tarife mit Preisliste (Abrechnungsmodell): Hier gilt dasselbe wie für Tarife mit Umsatzbeteiligung. Sie können die Währungseinstellung jedoch in eine beliebige Währung ändern, die von der Organisation unterstützt wird. Bei Tarifen mit Gebühren: Sie können die Währungseinstellung in eine beliebige Währung ändern, die von der Organisation unterstützt wird. |
– | Ja |
description |
Kurze Beschreibung der Organisation. |
– | Nein |
hasBillingAdjustment |
Flag, die angibt, ob Anpassungen aktiviert sind. Wenn diese Option aktiviert ist, können Sie die von API Services für Ihre API-Produkte erfassten Trafficdetails anpassen. Der Wert kann einer der folgenden sein:
|
– | Nein |
hasBroker |
Flag, das angibt, ob der Umsatz auf dem Nettobetrag basiert. Der Wert kann einer der folgenden sein:
|
– | Nein |
hasSelfBilling |
Flag, das die Monetarisierung anweist, eine Rechnung mit Selbstabrechnung anstelle einer Umsatzbeteiligung zu erstellen. Eine Rechnung mit Selbstabrechnung ist ein Finanzdokument, in dem der dem App-Entwickler geschuldete Betrag aufgeführt ist. Sie fungiert als Rechnung an den API-Anbieter im Namen des App-Entwicklers. Der Wert kann einer der folgenden sein:
|
– | Nein |
hasSeparateInvoiceForProduct |
Flag, das angibt, ob für jedes API-Produkt eine separate Rechnung erstellt wird. Der Wert kann einer der folgenden sein:
|
– | Nein |
id |
ID der Organisation. |
– | Nein |
issueNettingStmt |
Flag, das angibt, ob beim Erstellen von Abrechnungsdokumenten eine Netting-Erklärung generiert wird. Der Wert kann einer der folgenden sein:
|
– | Nein |
logoUrl |
URL des Logos der Organisation. |
– | Nein |
name |
Name der Organisation. |
– | Ja |
netPaymentAdviceNote |
Hinweis zur Nettozahlung. |
– | Nein |
nettingStmtPerCurrency |
Flag, das angibt, ob für jede verwendete Währung eine separate Abrechnungserklärung generiert wird. Der Wert kann einer der folgenden sein:
|
– | Nein |
regNo |
Registrierungsnummer der Organisation. Die Nummer, die Sie für diese Property eingeben, wird unten auf Abrechnungsdokumenten angezeigt. |
– | Nein |
selfBillingAsExchOrg |
Gibt an, ob die Selbstabrechnung aktiviert ist und ob sie für Austauschorganisationen aktiviert ist. Der Wert kann einer der folgenden sein:
|
– | Nein |
selfBillingForAllDev |
Gibt an, ob die Funktion für alle App-Entwickler aktiviert ist, wenn Rechnungen mit Selbstabrechnung aktiviert sind. Standardmäßig werden Rechnungen mit Selbstabrechnung nur für App-Entwickler generiert, die eine Vereinbarung mit dem API-Anbieter unterzeichnet haben. Der Wert kann einer der folgenden sein:
|
falsch | Nein |
separateInvoiceForFees |
Flag, das angibt, ob für Gebühren eine separate Rechnung veröffentlicht wird. Der Wert kann einer der folgenden sein:
|
falsch | Ja |
status |
Status der Organisation. Gültige Werte sind:
|
– | Nein |
supportedBillingType |
Das für die Abrechnung verwendete Zahlungsmodell für Entwickler. Der Wert kann einer der folgenden sein:
Weitere Informationen finden Sie unter Prepaid- und Postpaid-Abrechnungstypen mit der API konfigurieren. |
PREPAID | Ja |
taxModel |
Hinweis:Gilt nur, wenn Sie Tarifpakete mit Umsatzbeteiligungsraten eingerichtet haben und Abrechnungsdokumente erstellen möchten. Steuermodell für Tarife mit Umsatzbeteiligung, das den Typ der erforderlichen Abrechnungsdokumente angibt. Gültige Werte sind:
|
– | Ja |
taxNexus |
Das Land, in dem die Organisation steuerlich registriert ist. |
– | Nein |
taxRegNo |
Die Steuernummer oder Umsatzsteuer-Identifikationsnummer der Organisation, sofern zutreffend. Diese Property ist optional, da die Steuernummer oder Umsatzsteuer-Identifikationsnummer nicht in allen Ländern gilt. Die Nummer, die Sie für diesen Parameter eingeben, wird unten auf Abrechnungsdokumenten angezeigt. |
– | Nein |
transactionRelayURL |
URL eines anderen Systems, an das Transaktionen weitergeleitet werden können, z. B. ein Data Warehouse. |
– | Nein |
timezone |
Die Zeitzonenkennung für die Vorgänge der Organisation, z. B. „America/New_York“ oder „Europe/Paris“. Zeitzonenabkürzungen wie UTC, EST (Eastern Standard Time) oder CET (Central European Time) werden ebenfalls unterstützt. |
– | Ja |
Monetarisierungsprofileinstellungen für ein Unternehmen oder einen App-Entwickler überschreiben
Überschreiben Sie die Einstellungen des Monetarisierungsprofils für ein Unternehmen oder einen App-Entwickler über die Benutzeroberfläche oder die API, wie in den folgenden Abschnitten beschrieben: