Organisationsprofil verwalten

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

In den folgenden Abschnitten wird das Organisationsprofil vorgestellt und beschrieben, wie es mithilfe der Benutzeroberfläche und API verwaltet werden kann.

Informationen zum Unternehmensprofil

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 über Ihre Organisation, darunter:

• Name, Adresse und Land der Organisation
• Abrechnungsart (Prepaid, Postpaid oder beides), wie unter Abrechnungsart verstehen beschrieben
• Abrechnungszeitraum (anteilig oder Kalendermonat)
• Basiswährung
• Von deiner Organisation verwendetes Steuermodell

Sie können Ihr Organisationsprofil mithilfe der UI und der API verwalten, wie in den folgenden Abschnitten beschrieben.

Seite „Unternehmensprofil“ kennenlernen

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

Organisationsprofil über die UI bearbeiten

So bearbeiten Sie das Organisationsprofil über die UI:

1. Rufen Sie die Seite Organisationsprofil auf.
2. Klicken Sie auf Bearbeiten.
3. Bearbeiten Sie unter Name und Informationen den Namen und das Land der Organisation.
4. Bearbeiten Sie unter Steuern und Währung die folgenden Felder:

   Feld	Beschreibung
   Steuermodell	Hinweis: Gilt nur, wenn Sie Tarifpläne mit Umsatzbeteiligung einrichten und Abrechnungsunterlagen generieren möchten. Steuermodell für Umsatzbeteiligungen, das die Art der erforderlichen Abrechnungsunterlagen angibt. Gültige Werte sind: Offengelegt: Der API-Anbieter fungiert als offengelegter Vertreter des Entwicklers. Der vom Endnutzer erhobene Bruttoumsatz (einschließlich Umsatzsteuer) wird an den Entwickler weitergegeben. Die Provision des API-Anbieters wird vom Entwickler in Form einer Provisionsrechnung eingezogen. Der API-Anbieter kümmert sich nicht um die vom Endnutzer erhobene Umsatzsteuer und der Entwickler ist dafür verantwortlich, die Umsatzsteuer zu melden. Nicht angegeben: Der API-Anbieter fungiert als nicht angegebener Vertreter des Entwicklers, zieht die von den Endnutzern erhobenen Steuern ab und führt sie an die lokalen Steuerbehörden ab. Der Entwickler stellt dem API-Anbieter die Netto-Umsatzbeteiligung des Entwicklers in Rechnung (abzüglich der Mehrwertsteuer und der Provision des API-Anbieters). Hybrid: Der API-Anbieter fungiert als offengelegter Agent des Entwicklers. Allerdings zahlt der API-Anbieter die von seinen Abonnenten erhobene Umsatzsteuer im Namen des Entwicklers an die lokalen Steuerbehörden. Der API-Anbieter übergibt den verbleibenden Umsatz an den Entwickler und stellt dann die Provisionsgebühren in Rechnung.
   Currency	Von Ihrer Organisation unterstützte Währungen Für Umsatzbeteiligungen, Preislisten und Nur-Gebührenpläne wird die Standardwährung in Ihrem Preisplan verwendet. Wenn Sie eine Preisliste oder einen reinen Gebührenplan erstellen, können Sie die zu verwendende Währung ändern, indem Sie eine Währung aus einer Liste der unterstützten Währungen auswählen. Optional können Sie den Mindesteinzahlungsbetrag festlegen, den App-Entwickler für jede Währung zum Prepaidguthaben aufladen können. So fügen Sie eine Währung hinzu: Klicken Sie auf Währung hinzufügen. Wählen Sie im Feld Währung eine Währung aus dem Drop-down-Menü aus. Optional können Sie im Feld Minimales Aufladen den Mindestbetrag in der angegebenen Währung festlegen, den App-Entwickler ihrem Prepaidguthaben aufladen können. Klicken Sie auf Hinzufügen. Legen Sie gegebenenfalls eine Standardwährung fest, indem Sie auf das entsprechende Optionsfeld klicken. Wiederholen Sie die Schritte, um weitere Währungen hinzuzufügen. Um eine Währung zu löschen, bewegen Sie den Mauszeiger auf die Währung, die Sie löschen möchten, und klicken Sie auf .

5. Verwalten Sie Nutzungsbedingungen wie unter Nutzungsbedingungen über die Benutzeroberfläche verwalten beschrieben.
6. Klicken Sie auf Speichern.

Organisationsprofil mithilfe der API verwalten

Verwalten Sie das Organisationsprofil mithilfe der API, wie in den folgenden Abschnitten beschrieben.

Organisationsprofil über die API ansehen

Sehen Sie sich das Profil Ihrer Organisation an, 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 Eigenschaften der Organisationsprofilkonfiguration 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 mithilfe 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, die Sie bearbeiten.

Wenn Sie die Standardwährung für die Organisation bearbeiten möchten, legen Sie den Wert currency auf den Währungscode nach ISO 4217 der unterstützten Währung fest, die Sie als Standard festlegen möchten.

Mit dem folgenden API-Aufruf werden beispielsweise currency in USD und die Einstellung für das Steuermodell in HYBRID geändert. Die aktualisierten Felder sind im Beispiel hervorgehoben. Weitere Informationen zu den angezeigten Optionen finden Sie unter Eigenschaften der Organisationsprofilkonfiguration 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 mithilfe der API konfigurieren

Entwicklerkonten können für die folgenden Abrechnungsarten konfiguriert werden: Prepaid, Postpaid oder beides.

Bei Konten mit Prepaid-Guthaben zahlen Entwickler im Voraus für die Nutzung Ihrer APIs. Die Kosten werden vom Prepaidguthaben des Entwicklers abgezogen, das über einen integrierten Zahlungsdienstleister verwaltet wird. Der Entwickler muss über ein ausreichendes Prepaidguthaben für den Kauf der APIs verfügen.

Bei Konten mit nachträglicher Zahlung erfolgt die Abrechnung für Entwickler monatlich (über eine Rechnung) am Monatsende. Der Entwickler bezahlt für die Nutzung von API-Produkten auf der Grundlage der Zahlungsbedingungen, die in den Tarifen auf der Rechnung festgelegt sind.

Um Prepaid- und Postpaid-Abrechnungstypen für Ihre Organisation zu konfigurieren, setzen Sie das Attribut supportedBillingType auf einen der folgenden Werte, um anzugeben, welche Abrechnungstypen gültig sind: PREPAID, POSTPAID oder BOTH. Wenn du den Wert auf BOTH festlegst, ist der Standardwert PREPAID, wenn du einen App-Entwickler oder ein Unternehmen hinzufügst. In diesem Fall kannst du mithilfe der API explizit den Abrechnungstyp für ein Unternehmen oder einen App-Entwickler festlegen, wie unter Verwaltung von Unternehmen und App-Entwickler 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 mithilfe der API konfigurieren

Um den Abrechnungszeitraum für Ihre Organisation zu konfigurieren, legen Sie für das Attribut billingCycle einen der folgenden Werte fest:

• PRORATED: Die Abrechnung basiert auf der Anzahl der Tage, an denen ein API-Produkt in einem Kalendermonat genutzt 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

Konfigurationsattribute des Unternehmensprofils für die API

Im Organisationsprofil können Sie die folgenden Konfigurationsattribute mithilfe der API festlegen.

Name	Beschreibung	Standard	Erforderlich?
address	Die Adresse der Organisation, die Straße, Stadt, Bundesland, Postleitzahl und Land umfassen kann. Außerdem kann angegeben werden, ob dies die primäre Adresse der Organisation ist.	–	Nein
approveTrusted	Dieses Flag wird nicht verwendet.	–	Nein
approveUntrusted	Dieses Flag wird nicht verwendet.	–	Nein
billingCycle	Abrechnungszeitraum. Der Wert kann einer der folgenden sein: PRORATED: Die Abrechnung basiert auf der Anzahl der Tage, an denen ein API-Produkt in einem Kalendermonat genutzt wird. CALENDAR_MONTH: Die Abrechnung erfolgt monatlich. Weitere Informationen finden Sie unter Abrechnungszeitraum mithilfe der API konfigurieren.	–	Ja
country	ISO-3166-2-Code für das Land, in dem die Organisation tätig ist, z. B. Brasilien für Brasilien.	–	Ja
currency	ISO-4217-Code für die Basis- oder Abrechnungswährung, die die Organisation verwendet (z. B. USD für US-Dollar). Für Pläne mit Umsatzbeteiligung: Die angegebene Währung wird für Ihren Plan verwendet. Für Preislistenpläne mit Abrechnungsmodell gilt dasselbe wie für Pläne mit Umsatzbeteiligung. Sie können jedoch die Währungseinstellung in eine beliebige Währung ändern, die von der Organisation unterstützt wird. Für Nur-Gebühren-Tarife: Sie können die Währungseinstellung in jede Währung ändern, die von der Organisation unterstützt wird.	–	Ja
description	Kurze Beschreibung der Organisation.	–	Nein
hasBillingAdjustment	Flag, das angibt, ob Anpassungen aktiviert sind. Wenn diese Option aktiviert ist, können Sie die Trafficdetails anpassen, die von API-Diensten für Ihre API-Produkte aufgezeichnet wurden. Folgende Werte sind möglich: true: Anpassungen sind aktiviert. false: Anpassungen sind nicht aktiviert.	–	Nein
hasBroker	Flag, das angibt, ob der Umsatz auf Nettowerten basiert. Folgende Werte sind möglich: true: Der Umsatz basiert auf Nettowerten. false: Der Umsatz basiert nicht auf Nettowert.	–	Nein
hasSelfBilling	Melden, das die Monetarisierung anleitet, eine Rechnung zur Selbstabrechnung anstelle einer Umsatzbeteiligung zu erstellen. Eine Rechnung zur Selbstabrechnung ist ein Finanzdokument, in dem der Betrag aufgeführt ist, der dem App-Entwickler zusteht. Er dient als Rechnung für den API-Anbieter im Namen des App-Entwicklers. Folgende Werte sind möglich: true: Damit werden Rechnungen mit Selbstauskünften anstelle von Aufstellungen zur Umsatzbeteiligung erstellt. false: Deaktiviert Rechnungen mit der Selbstabrechnung.	–	Nein
hasSeparateInvoiceForProduct	Angabe, ob für jedes API-Produkt eine separate Rechnung erstellt wird. Folgende Werte sind möglich: true: Für jedes API-Produkt wird eine separate Rechnung erstellt. false: Es wird keine separate Rechnung für jedes API-Produkt erstellt.	–	Nein
id	ID der Organisation.	–	Nein
issueNettingStmt	Flag, das angibt, ob beim Erstellen von Abrechnungsdokumenten eine Netting-Anweisung generiert wird. Folgende Werte sind möglich: true: Beim Erstellen von Abrechnungsdokumenten wird eine Netzwerkanweisung generiert. false: Beim Erstellen von Abrechnungsunterlagen wird keine Netzanweisung generiert.	–	Nein
logoUrl	URL des Logos der Organisation.	–	Nein
name	Name der Organisation.	–	Ja
netPaymentAdviceNote	Netto-Zahlungshinweis.	–	Nein
nettingStmtPerCurrency	Flag, das angibt, ob für jede verwendete Währung eine separate Netting-Anweisung generiert wird. Folgende Werte sind möglich: true: Für jede verwendete Währung wird eine separate Abrechnung erstellt. false: Eine separate Netting-Anweisung wird nicht für jede verwendete Währung generiert.	–	Nein
regNo	Die Registrierungsnummer der Organisation. Die Nummer, die Sie für diese Property eingeben, wird unten auf den Abrechnungsdokumenten angezeigt.	–	Nein
selfBillingAsExchOrg	Gibt an, ob Rechnungen mit Selbstabrechnung aktiviert sind. Folgende Werte sind möglich: true: Rechnungen mit automatischer Abrechnung sind für Anzeigenplattform-Organisationen aktiviert. false: Rechnungen mit automatischer Abrechnung sind für Anzeigenplattform-Organisationen nicht aktiviert.	–	Nein
selfBillingForAllDev	Wenn Rechnungen mit Selbstabrechnung aktiviert sind, wird angegeben, ob sie für alle App-Entwickler aktiviert ist. Rechnungen mit Selbstabrechnung werden standardmäßig nur für App-Entwickler erstellt, die eine Vereinbarung mit dem API-Anbieter unterzeichnet haben. Folgende Werte sind möglich: true: Rechnungen mit Selbstabrechnung sind für alle App-Entwickler aktiviert. false: Rechnungen mit Selbstabrechnung sind nicht für alle App-Entwickler aktiviert.	false	Nein
separateInvoiceForFees	Angabe, ob eine separate Rechnung mit Gebühren veröffentlicht wird. Folgende Werte sind möglich: true: Es wird eine separate Rechnung für Gebühren veröffentlicht. false: Es wird keine separate Rechnung für Gebühren veröffentlicht.	false	Ja
status	Status der Organisation. Gültige Werte sind: AKTIV: Das Organisationskonto ist für die Monetarisierung registriert und kann verwendet werden. INAKTIV: Das Organisationskonto ist für die Monetarisierung registriert, kann aber nicht verwendet werden.	–	Nein
supportedBillingType	Das für die Abrechnung verwendete Zahlungsmodell des Entwicklers. Der Wert kann einer der folgenden sein: Vorauszahlung: Der Entwickler zahlt im Voraus für die Nutzung eines API-Produkts. Wenn das API-Produkt verwendet wird, wird der Betrag vom Guthaben des Entwicklers abgezogen. Der Entwickler muss über ein ausreichendes Prepaidguthaben für den Kauf des API-Produkts verfügen. Nachträgliche Abrechnung: Die Nutzung von API-Produkten wird dem Entwickler monatlich (über eine Rechnung) in Rechnung gestellt. Der Entwickler bezahlt die Kosten für die Nutzung von API-Produkten gemäß den Zahlungsbedingungen, die in den Tarifen auf der Rechnung festgelegt sind. BOTH (Beides): Unterstützt beide Abrechnungstypen. Die Standardeinstellung ist PREPAID. Siehe Prepaid- und Postpaid-Abrechnungstypen mit der API konfigurieren.	VORAUSZAHLUNG	Ja
taxModel	Hinweis: Gilt nur, wenn Sie Tarifpläne mit Umsatzbeteiligung einrichten und Abrechnungsunterlagen generieren möchten. Steuermodell für Umsatzbeteiligungen, das die Art der erforderlichen Abrechnungsunterlagen angibt. Gültige Werte sind: Offengelegt: Der API-Anbieter fungiert als offengelegter Vertreter des Entwicklers. Der vom Endnutzer erhobene Bruttoumsatz (einschließlich Umsatzsteuer) wird an den Entwickler weitergegeben. Die Provision des API-Anbieters wird vom Entwickler in Form einer Provisionsrechnung eingezogen. Der API-Anbieter kümmert sich nicht um die vom Endnutzer erhobene Umsatzsteuer und der Entwickler ist dafür verantwortlich, die Umsatzsteuer zu melden. Nicht angegeben: Der API-Anbieter fungiert als nicht angegebener Vertreter des Entwicklers, zieht die von den Endnutzern erhobenen Steuern ab und führt sie an die lokalen Steuerbehörden ab. Der Entwickler stellt dem API-Anbieter die Netto-Umsatzbeteiligung des Entwicklers in Rechnung (abzüglich der Mehrwertsteuer und der Provision des API-Anbieters). Hybrid: Der API-Anbieter fungiert als offengelegter Agent des Entwicklers. Allerdings zahlt der API-Anbieter die von seinen Abonnenten erhobene Umsatzsteuer im Namen des Entwicklers an die lokalen Steuerbehörden. Der API-Anbieter übergibt den verbleibenden Umsatz an den Entwickler und stellt dann die Provisionsgebühren in Rechnung.	–	Ja
taxNexus	Das Land, in dem die Organisation steuerlich registriert ist.	–	Nein
taxRegNo	Gegebenenfalls die Steuernummer der Organisation oder die Umsatzsteuer-Identifikationsnummer. Diese Eigenschaft ist optional, da die Steuernummer oder die Umsatzsteuer-Identifikationsnummer nicht in allen Ländern gilt. Die Zahl, die Sie für diesen Parameter eingeben, wird unten auf den Abrechnungsdokumenten angezeigt.	–	Nein
transactionRelayURL	URL eines anderen Systems, an das Transaktionen weitergeleitet werden können, z. B. eines 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

Einstellungen des Monetarisierungsprofils für ein Unternehmen oder einen App-Entwickler überschreiben

Überschreiben Sie die Einstellungen für das Monetarisierungsprofil für ein Unternehmen oder einen App-Entwickler mithilfe der Benutzeroberfläche oder der API, wie in den folgenden Abschnitten beschrieben:

• Benutzerdefinierte Attribute für einen App-Entwickler verwalten
• Verwaltung von Unternehmen und App-Entwicklern
• App-Entwickler verwalten