Organisationsprofil verwalten

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info

In den folgenden Abschnitten wird das Unternehmensprofil vorgestellt und beschrieben, wie Sie es über die Benutzeroberfläche und die API verwalten können.

Das 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 der Organisation
• Abrechnungstyp (Prepaid, Postpaid oder beides), wie unter Art der Abrechnung beschrieben
• Abrechnungszeitraum (anteilige Abrechnung 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 „Profil der Organisation“

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

Organisationsprofil über die Benutzeroberfläche bearbeiten

So bearbeiten Sie das Organisationsprofil über die Benutzeroberfläche:

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

   Feld	Beschreibung
   Steuermodell	Hinweis:Dieser Vorgang ist nur erforderlich, wenn Sie Tarifpakete mit Umsatzbeteiligung eingerichtet haben und Abrechnungsdokumente generieren möchten. Steuermodell für Tarife mit Umsatzbeteiligung, das den erforderlichen Abrechnungsdokumenttyp angibt. Gültige Werte sind: Offengelegt: Der API-Anbieter fungiert als offengelegter Agent des Entwicklers. Der Bruttoumsatz (einschließlich Umsatzsteuer), der vom Endnutzer eingenommen wird, wird an den Entwickler weitergeleitet. Die Provision des API-Anbieters wird in Form einer Provisionsrechnung vom Entwickler eingezogen. Der API-Anbieter kümmert sich nicht um die vom Endnutzer erhobene Umsatzsteuer. Es liegt in der Verantwortung des Entwicklers, die Umsatzsteuer anzugeben. Nicht offengelegt: Der API-Anbieter fungiert als nicht offengelegter Vertreter des Entwicklers und zieht die von den Endnutzern erhobenen Steuern ab und zahlt sie an die lokalen Steuerbehörden. Der Entwickler stellt dem API-Anbieter den ihm zustehenden Anteil am Nettoumsatz in Rechnung (abzüglich Umsatzsteuer und Provision des API-Anbieters). Hybrid: Der API-Anbieter fungiert als offengelegter Vertreter 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 ihm dann die Provision in Rechnung.
   Währung	Währungen, die von Ihrer Organisation unterstützt werden. Bei Umsatzbeteiligungs-, Preislisten- und reinen Gebührentarifen wird die Standardwährung für deinen Preisplan verwendet. Wenn Sie eine Preisliste oder ein Tarifpaket ohne Abogebühr erstellen, können Sie die Währung ändern, indem Sie eine der unterstützten Währungen auswählen. Optional können Sie für jede Währung den Mindestbetrag festlegen, den App-Entwickler ihrem Prepaid-Kontoguthaben 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 Mindestaufstockung den Mindestbetrag festlegen, den App-Entwickler ihrem Prepaid-Konto in der angegebenen Währung hinzufügen können. Klicken Sie auf Hinzufügen. Klicken Sie auf das zugehörige Optionsfeld, um die Währung als Standardwährung festzulegen. 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 .

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

Organisationsprofil mit der API verwalten

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

Organisationsprofil mit der API aufrufen

Senden Sie eine GET-Anfrage an /mint/organizations/{org_name}, um Ihr Organisationsprofil aufzurufen. 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 des Unternehmensprofils 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 Unternehmensprofil bearbeiten, müssen Sie alle Eigenschaften des Unternehmensprofils 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 ISO 4217-Währungscode der unterstützten Währung fest, die Sie als Standard festlegen möchten.

Im folgenden API-Aufruf wird beispielsweise currency auf „USD“ und die Steuermodelleinstellung auf HYBRID aktualisiert. Die aktualisierten Felder sind im Beispiel hervorgehoben. Weitere Informationen zu den angezeigten Optionen finden Sie unter Konfigurationseigenschaften 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

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

Bei Prepaid-Konten bezahlen Entwickler im Voraus für die Nutzung Ihrer APIs. Die Zahlungen werden vom Prepaid-Guthaben des Entwicklers abgezogen, das über einen integrierten Zahlungsanbieter verwaltet wird. Der Entwickler muss über ein Vorauszahlungsguthaben verfügen, das zum Kauf der APIs ausreicht.

Bei Postpaid-Konten werden Entwicklern die Kosten am Ende des Monats in Rechnung gestellt. 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 für Prepaid- und Postpaid-Abos für Ihre Organisation konfigurieren möchten, legen Sie für die Property supportedBillingType einen der folgenden Werte fest, um anzugeben, welche Abrechnungstypen zulässig sind: PREPAID, POSTPAID oder BOTH. Wenn Sie den Wert auf BOTH festlegen, ist PREPAID der Standardwert, 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 mithilfe der API explizit 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

Legen Sie für die Abrechnung für Ihre Organisation einen der folgenden Werte für die Property billingCycle fest:

• PRORATED: Die Abrechnung erfolgt anhand 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 des Unternehmensprofils für die API

Im Organisationsprofil können Sie die folgenden Konfigurationseigenschaften über die API festlegen.

Name	Beschreibung	Standard	Erforderlich?
address	Adresse der Organisation, einschließlich Straße, Ort, Bundesland, Postleitzahl, Land und Angabe, ob es sich um die Hauptadresse der Organisation handelt.	–	Nein
approveTrusted	Dieses Flag wird nicht verwendet.	–	Nein
approveUntrusted	Dieses Flag wird nicht verwendet.	–	Nein
billingCycle	Abrechnungszeitraum. Der Wert kann einer der folgenden sein: ANteilig berechnet: Die Abrechnung basiert auf der Anzahl der Tage, an denen ein API-Produkt in einem Kalendermonat verwendet wird. CALENDAR_MONTH: Die Abrechnung erfolgt monatlich. Weitere Informationen finden Sie unter Abrechnungszeitraum mit der API konfigurieren.	–	Ja
country	ISO 3166-2-Code für das Land, in dem die Organisation ihren Sitz hat, z. B. „BR“ für Brasilien.	–	Ja
currency	ISO 4217-Code für die „Basis“ oder die von der Organisation verwendete Währung (z. B. „USD“ für US-Dollar). Bei Umsatzbeteiligungsplänen: Die angegebene Währung wird für deinen Plan verwendet. Für Tarifpläne (Abrechnungsmodell): Hier gilt das Gleiche wie für Umsatzbeteiligungspläne. Sie können die Währungseinstellung jedoch in eine beliebige Währung ändern, die von der Organisation unterstützt wird. Bei Abos ohne kostenlose Testzeit: 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	Gibt an, ob Anpassungen aktiviert sind. Wenn diese Option aktiviert ist, können Sie Anpassungen an den von API-Diensten für Ihre API-Produkte erfassten Traffic-Details vornehmen. Der Wert kann einer der folgenden sein: „wahr“: Anpassungen sind aktiviert. „false“: Anpassungen sind nicht aktiviert.	–	Nein
hasBroker	Gibt an, ob der Umsatz auf dem Bruttoumsatz basiert. Der Wert kann einen der folgenden Werte haben: wahr: Der Umsatz basiert auf dem Nettoumsatz. falsch: Der Umsatz basiert nicht auf dem Nettoumsatz.	–	Nein
hasSelfBilling	Flag, das die Monetarisierung anweist, eine Rechnung für die Selbstabrechnung anstelle einer Umsatzbeteiligungsabrechnung zu generieren. Eine Rechnung für die Selbstabrechnung ist ein Finanzdokument, das den dem App-Entwickler geschuldeten Betrag enthält. Sie fungiert als Rechnung an den API-Anbieter im Namen des App-Entwicklers. Der Wert kann einer der folgenden sein: „wahr“: Es werden Rechnungen mit eigener Abrechnung anstelle von Umsatzbeteiligungsabrechnungen generiert. false: Deaktiviert Rechnungen mit eigener Abrechnung.	–	Nein
hasSeparateInvoiceForProduct	Flag, das angibt, ob für jedes API-Produkt eine separate Rechnung erstellt wird. Der Wert kann einer der folgenden sein: true: Für jedes API-Produkt wird eine separate Rechnung erstellt. falsch: Für jedes API-Produkt wird keine separate Rechnung erstellt.	–	Nein
id	ID der Organisation.	–	Nein
issueNettingStmt	Gibt an, ob beim Erstellen von Abrechnungsdokumenten eine Saldierungsabrechnung generiert wird. Der Wert kann einer der folgenden sein: „true“: Die Saldierungsabrechnung wird beim Erstellen von Abrechnungsdokumenten generiert. false: Beim Erstellen von Abrechnungsdokumenten wird keine Saldierungsabrechnung generiert.	–	Nein
logoUrl	URL des Logos der Organisation.	–	Nein
name	Name der Organisation.	–	Ja
netPaymentAdviceNote	Hinweis zur Nettozahlung	–	Nein
nettingStmtPerCurrency	Gibt an, ob für jede verwendete Währung eine separate Saldierungsabrechnung generiert wird. Der Wert kann einer der folgenden sein: „wahr“: Für jede verwendete Währung wird eine separate Saldierungsabrechnung erstellt. false: Für jede verwendete Währung wird keine separate Saldierungsabrechnung erstellt.	–	Nein
regNo	Die Registrierungsnummer der Organisation. Die von Ihnen für diese Property eingegebene Nummer wird unten in den Abrechnungsunterlagen angezeigt.	–	Nein
selfBillingAsExchOrg	Gibt an, ob die Rechnungsstellung durch den Kunden für Organisationen aktiviert ist, die mit dem Anzeigenplattform-Dienst arbeiten. Der Wert kann einer der folgenden sein: „true“: Für Anzeigenplattformen sind Rechnungen zur Selbstabrechnung aktiviert. falsch: Für Anzeigenplattformen sind keine Rechnungen zur Selbstabrechnung verfügbar.	–	Nein
selfBillingForAllDev	Gibt an, ob die Rechnungsstellung für Entwickler aktiviert ist und ob sie für alle App-Entwickler gilt. Standardmäßig werden Rechnungen für die Selbstabrechnung nur für App-Entwickler erstellt, die eine Vereinbarung mit dem API-Anbieter unterzeichnet haben. Der Wert kann einer der folgenden sein: true: Rechnungen zur Selbstabrechnung sind für alle App-Entwickler aktiviert. falsch: Rechnungen zur Selbstabrechnung sind nicht für alle App-Entwickler aktiviert.	falsch	Nein
separateInvoiceForFees	Gibt an, ob für Gebühren eine separate Rechnung veröffentlicht wird. Der Wert kann einer der folgenden sein: „wahr“: Für Gebühren wird eine separate Rechnung veröffentlicht. false: Für Gebühren wird keine separate Rechnung veröffentlicht.	falsch	Ja
status	Status der Organisation. Gültige Werte sind: AKTIV: Das Organisationskonto ist für die Monetarisierung registriert und kann verwendet werden. INAKTIV: Das Unternehmenskonto 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: PREPAID: Der Entwickler bezahlt im Voraus für die Nutzung eines API-Produkts. Die Verwendung des API-Produkts wird vom Guthaben des Entwicklers abgezogen. Der Entwickler muss über ein Vorauszahlungsguthaben verfügen, das zum Kauf des API-Produkts ausreicht. POSTPAID: Die Nutzung von API-Produkten wird dem Entwickler monatlich in Rechnung gestellt. Der Entwickler bezahlt für die Nutzung von API-Produkten basierend auf den Zahlungsbedingungen, die in den auf der Rechnung enthaltenen Tarifen angegeben sind. BEIDE: Es wird jeder Abrechnungstyp unterstützt. Die Standardeinstellung ist PREPAID. Weitere Informationen finden Sie unter Vorab- und Postpaid-Abrechnungstypen mit der API konfigurieren.	PREPAID	Ja
taxModel	Hinweis:Dieser Vorgang ist nur erforderlich, wenn Sie Tarifpakete mit Umsatzbeteiligung eingerichtet haben und Abrechnungsdokumente generieren möchten. Steuermodell für Tarife mit Umsatzbeteiligung, das den erforderlichen Abrechnungsdokumenttyp angibt. Gültige Werte sind: Offengelegt: Der API-Anbieter fungiert als offengelegter Agent des Entwicklers. Der Bruttoumsatz (einschließlich Umsatzsteuer), der vom Endnutzer eingenommen wird, wird an den Entwickler weitergeleitet. Die Provision des API-Anbieters wird in Form einer Provisionsrechnung vom Entwickler eingezogen. Der API-Anbieter kümmert sich nicht um die vom Endnutzer erhobene Umsatzsteuer. Es liegt in der Verantwortung des Entwicklers, die Umsatzsteuer anzugeben. Nicht offengelegt: Der API-Anbieter fungiert als nicht offengelegter Vertreter des Entwicklers und zieht die von den Endnutzern erhobenen Steuern ab und zahlt sie an die lokalen Steuerbehörden. Der Entwickler stellt dem API-Anbieter den ihm zustehenden Anteil am Nettoumsatz in Rechnung (abzüglich Umsatzsteuer und Provision des API-Anbieters). Hybrid: Der API-Anbieter fungiert als offengelegter Vertreter 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 ihm dann die Provision in Rechnung.	–	Ja
taxNexus	Das Land, in dem die Organisation steuerlich registriert ist.	–	Nein
taxRegNo	Steuerregistrierungsnummer oder Umsatzsteuer-Identifikationsnummer der Organisation, sofern zutreffend. Dieses Attribut ist optional, da die Steuerregistrierungsnummer oder Umsatzsteuer-Identifikationsnummer nicht in allen Ländern gilt. Die für diesen Parameter eingegebene Zahl wird unten in den Abrechnungsunterlagen angezeigt.	–	Nein
transactionRelayURL	URL eines anderen Systems, an das Transaktionen weitergeleitet werden können, z. B. eines Data Warehouse.	–	Nein
timezone	Die Zeitzonen-ID für die Geschäftstätigkeiten der Organisation, z. B. „America/New_York“ oder „Europe/Paris“. Auch Zeitzonen-Abkürzungen wie UTC, EST (Eastern Standard Time) oder CET (Central European Time) werden unterstützt.	–	Ja

Einstellungen des Monetarisierungsprofils 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 API, wie in den folgenden Abschnitten beschrieben:

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