Zarządzanie profilem organizacji

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X.
informacje.

W kolejnych sekcjach znajdziesz opis profilu organizacji oraz sposób, w jaki możesz nim zarządzać za pomocą interfejsu użytkownika i interfejsu API.

Informacje o profilu organizacji

W ramach wstępnej konfiguracji zarabiania zespół konfiguracji Apigee Edge konfiguruje profil Twojej organizacji.

Aby dodać lub zaktualizować informacje o organizacji, musisz edytować profil organizacji. Może być na przykład konieczna aktualizacja typu płatności, ustawień waluty lub modelu podatkowego.

Skonfiguruj podstawowe informacje o organizacji, w tym:

  • Nazwa, adres i kraj organizacji
  • typ płatności (przedpłata, płatność po wykonaniu usługi lub oba te rodzaje płatności), zgodnie z opisem w artykule Omówienie typu płatności;
  • Cykl rozliczeniowy (proporcjonalnie lub miesiąc kalendarzowy)
  • Waluta podstawowa
  • Model podatkowy używany przez Twoją organizację

Profilem organizacji możesz zarządzać za pomocą interfejsu i interfejsu API, zgodnie z opisem w artykule w następujących sekcjach.

Poznawanie strony profilu organizacji

Otwórz stronę Profil organizacji w sposób opisany poniżej.

Edge

Aby uzyskać dostęp do strony profilu organizacji przy użyciu interfejsu Edge:

  1. Zaloguj się na stronie apigee.com/edge.
  2. Kliknij Opublikuj > Zarabianie > Profil organizacji na pasku nawigacyjnym po lewej stronie.

Zostanie wyświetlona strona Profil organizacji.

Jak zaznaczono na ilustracji, na stronie Profil organizacji można:

Classic Edge (Private Cloud)

Aby uzyskać dostęp do strony profilu organizacji w interfejsie klasycznej wersji Edge:

  1. Zaloguj się w aplikacji http://ms-ip:9000, gdzie ms-ip to adres Adres IP lub nazwa DNS węzła serwera zarządzania.
  2. Wybierz Administracja > Profil organizacji na górnym pasku nawigacyjnym.

Zostanie wyświetlona strona Profil organizacji.

Na stronie Profil organizacji możesz:

Edytowanie profilu organizacji za pomocą interfejsu użytkownika

Aby edytować profil organizacji za pomocą interfejsu użytkownika:

  1. Otwórz stronę profilu organizacji.
  2. Kliknij Edytuj.
  3. W sekcji Nazwa i informacje edytuj nazwę organizacji i kraj, w którym działa.
  4. W sekcji Podatki i waluta edytuj te pola:
    Pole Opis
    Model podatkowy

    Uwaga: ma zastosowanie tylko wtedy, gdy masz skonfigurowane plany dzielenia się przychodami i chcesz w celu wygenerowania dokumentów rozliczeniowych.

    Model podatkowy dla planów stawek dzielenia się przychodami, który określa typ wymaganych dokumentów rozliczeniowych.

    Prawidłowe wartości to m.in.:

    • Ujawnione: dostawca interfejsu API działa jako ujawniony agent Google Play. Przychód brutto (w tym podatki od sprzedaży) pobierany od użytkownika wynosi i przekazywać je deweloperowi. Prowizja dostawcy interfejsu API jest pobierana od deweloper w formie faktury prowizyjnej. Dostawca interfejsu API nie obsługuje podatku od sprzedaży pobieranego od użytkownika, za który odpowiada programista. aby zgłosić podatek od sprzedaży.
    • Nieujawnione: dostawca interfejsu API działa jako nieujawniony agent dewelopera, odejmuje pobrany podatek od użytkowników i przekazuje go lokalnych urzędów skarbowych. Deweloper fakturuje dostawcę interfejsu API za przychody netto. należnej deweloperowi (bez podatków od sprzedaży i prowizji).
    • Hybrydowa: dostawca interfejsu API działa jako ujawniony agent Google Play. Dostawca interfejsu API opłaca jednak podatek od sprzedaży pobierany subskrybentów lokalnych urzędów skarbowych w imieniu dewelopera. Interfejs API przekazuje pozostałe przychody deweloperowi, a potem wystawia faktury prowizje.
    Waluta

    Waluty obsługiwane przez Twoją organizację. W przypadku dzielenia się przychodami, arkusza stawek i planów obejmujących tylko opłaty: w Twoim planie stawek używana jest waluta domyślna. Podczas tworzenia arkusza stawek lub planu obejmującego tylko opłaty możesz zmienić walutę możesz użyć, wybierając z listy obsługiwanych walut. Opcjonalnie możesz ustawić minimalną kwotę doładowania, którą deweloperzy aplikacji mogą dodać do salda konta przedpłaconego w przypadku każdej waluty.

    Aby dodać walutę:

    1. Kliknij Dodaj walutę.
    2. Wybierz walutę z menu w polu Waluta.
    3. Opcjonalnie w polu Minimalne doładowanie ustaw minimalną kwotę, jaką deweloperzy aplikacji mogą dodać do salda konta przedpłaconego, w podanej walucie.
    4. Kliknij Dodaj.
    5. W razie potrzeby ustaw ją jako domyślną, klikając odpowiedni przycisk opcji.
    6. Aby dodać kolejne waluty, powtórz te czynności.

    Aby usunąć walutę, najedź kursorem na walutę, którą chcesz usunąć, i kliknij .

  5. Zarządzaj warunkami zgodnie z opisem w sekcji Zarządzanie warunkami w interfejsie.
  6. Kliknij Zapisz.

Zarządzanie profilem organizacji przy użyciu interfejsu API

Zarządzaj profilem organizacji przy użyciu interfejsu API zgodnie z opisem w kolejnych sekcjach.

Wyświetlanie profilu organizacji przy użyciu interfejsu API

Wyświetl swój profil organizacji, wysyłając żądanie GET do /mint/organizations/{org_name} Na przykład:

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

Poniżej znajdziesz przykładową odpowiedź. Więcej informacji o opcjach Więcej informacji znajdziesz w sekcji Właściwości konfiguracji profilu organizacji w interfejsie 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"
}

Edytowanie profilu organizacji przy użyciu interfejsu API

Edytuj profil organizacji, wysyłając żądanie PUT do /mint/organizations/{org_name} Podczas edytowania profilu organizacji musisz podać wszystkie właściwości profilu organizacji, a nie tylko właściwości, które edytujesz.

Aby edytować domyślną walutę organizacji, ustaw wartość currency na waluta według normy ISO 4217, kodu obsługiwanej waluty, którą chcesz ustawić jako domyślną.

Na przykład to wywołanie interfejsu API aktualizuje currency na USD i model podatkowy na HYBRID (zaktualizowane pola są wyróżnione w przykładzie). Więcej informacje o wyświetlanych opcjach znajdziesz w artykule Konfiguracja profilu organizacji. dla interfejsu 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

Konfigurowanie przedpłat i płatności po wykonaniu usługi za pomocą interfejsu API

Konta deweloperów można skonfigurować tak, aby korzystały z tych form płatności: przedpłaconej, przedpłaconej lub obu.

W przypadku kont przedpłaconych deweloperzy płacą z góry za korzystanie z interfejsów API. Środki są odliczane od salda z góry dewelopera, które jest utrzymywane przez zintegrowanego dostawcę usług płatniczych. Deweloper musi utrzymywać saldo z przedpłaty wystarczające do zakupu interfejsów API.

W przypadku kont opłacanych po wykonaniu usługi deweloperzy są rozliczani co miesiąc (na podstawie faktury) na koniec miesiąca. Deweloper płaci za korzystanie z interfejsów API zgodnie z warunkami płatności określonymi w abonamentach uwzględnionych na fakturze.

Aby skonfigurować w swojej organizacji typy płatności przedpłaconych i po wykonaniu usługi, ustaw właściwość supportedBillingType na jedną z następujące wartości, aby wskazać, które typy płatności są prawidłowe: PREPAID, POSTPAID oraz BOTH. Jeśli ustawisz wartość BOTH, gdy dodajesz dewelopera lub firmę, domyślną wartością będzie PREPAID. W takim przypadku możesz za pomocą interfejsu API bezpośrednio ustawić typ płatności dla firmy lub dewelopera aplikacji, jak opisano w Zarządzanie firmami i deweloperami aplikacji

Na przykład:

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

Konfigurowanie cyklu rozliczeniowego za pomocą interfejsu API

Aby skonfigurować cykl rozliczeniowy organizacji, ustaw we właściwości billingCycle jedną z tych wartości:

  • PRORATED: płatności są naliczane na podstawie liczby dni w miesiącu kalendarzowym, w którym używana jest usługa API.
  • CALENDAR_MONTH: płatności są naliczane co miesiąc.

Na przykład:

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

Właściwości konfiguracji profilu organizacji na potrzeby interfejsu API

Profil organizacji umożliwia ustawianie poniższych właściwości konfiguracji przy użyciu interfejsu API.

Nazwa Opis Domyślny Wymagana?
address

Adres organizacji, który może zawierać ulicę, numer domu, miasto, województwo lub kod pocztowy kodu, kraju oraz wskazania, czy jest to podstawowy adres Twojej organizacji.

Nie dotyczy Nie
approveTrusted

Ta flaga nie jest używana.

Nie dotyczy Nie
approveUntrusted

Ta flaga nie jest używana.

Nie dotyczy Nie
billingCycle

Okres cyklu rozliczeniowego. Możliwe wartości:

  • PRORATEDOWANO: rozliczenia są oparte na liczbie dni, przez które usługa API jest używana miesiąc kalendarzowy.
  • CALENDAR_MONTH: płatności są naliczane co miesiąc.

Zapoznaj się z artykułem Konfigurowanie cyklu rozliczeniowego przy użyciu interfejsu API.

Nie dotyczy Tak
country

Kod ISO 3166-2 dla tego kraju działalności organizacji, np. BR w Brazylii.

Nie dotyczy Tak
currency

Kod ISO 4217 dla wartości „base” lub waluta księgowa używana w organizacji (np. PLN w przypadku Polski), dolara).

W przypadku planów dzielenia się przychodami: na potrzeby planu używana jest określona waluta.

W przypadku abonamentów z arkuszem stawek (modelu naliczania opłat): tak samo jak w przypadku planów dzielenia się przychodami. Możesz jednak zmienić ustawienie waluty na dowolną obsługiwaną przez Twojej organizacji.

W przypadku planów obejmujących tylko opłaty: możesz zmienić ustawienie waluty na dowolną obsługiwaną przez Twojej organizacji.

Nie dotyczy Tak
description

Krótki opis organizacji.

Nie dotyczy Nie
hasBillingAdjustment

Flaga, która określa, czy korekty są włączone. Jeśli ta opcja jest włączona, możesz dostosowań szczegółów ruchu zarejestrowanych przez usługi interfejsu API dla usług interfejsu API. może być jedną z tych wartości:

  • true: korekty są włączone.
  • false: korekty nie są włączone.
Nie dotyczy Nie
hasBroker

Flaga określająca, czy przychody są obliczane na podstawie netto. Wartość może być dowolną z tych wartości: następujące:

  • true: przychody są podawane na podstawie netto.
  • false: przychody nie są obliczane na podstawie netto.
Nie dotyczy Nie
hasSelfBilling

Flaga skłaniająca do wygenerowania przychodu z faktury za pomocą funkcji zarabiania, a nie przychodu oświadczenie dotyczące udostępnienia. Faktura samoobsługowa to dokument finansowy z określoną kwotą narzucane przez dewelopera aplikacji. Jest to faktura dla dostawcy interfejsu API w imieniu dewelopera aplikacji. Możliwe wartości:

  • true: zamiast raportów o udziale w przychodach generowane są faktury samoobsługowe.
  • false: wyłącza możliwość samodzielnego rozliczania faktur.
Nie dotyczy Nie
hasSeparateInvoiceForProduct

Flaga określająca, czy dla każdego interfejsu API generowana jest osobna faktura. może być jedną z tych wartości:

  • true: dla każdego interfejsu API generowana jest osobna faktura.
  • false: dla każdego produktu API oddzielna faktura nie jest generowana.
Nie dotyczy Nie
id

Identyfikator organizacji.

Nie dotyczy Nie
issueNettingStmt

Flaga określająca, czy zestawienie netto jest generowane podczas tworzenia płatności dokumenty. Możliwe wartości:

  • true: zestawienie operacji jest generowane podczas tworzenia dokumentów rozliczeniowych.
  • false: zestawienie netto nie jest generowane podczas tworzenia dokumentów rozliczeniowych.
Nie dotyczy Nie
logoUrl

Adres URL logo organizacji.

Nie dotyczy Nie
name

Nazwa organizacji.

Nie dotyczy Tak
netPaymentAdviceNote

Nota z poradą dotyczącą płatności netto.

Nie dotyczy Nie
nettingStmtPerCurrency

Flaga określająca, czy dla każdej z nich generowana jest osobna deklaracja netto używanej waluty. Możliwe wartości:

  • true: dla każdej użytej waluty jest generowany oddzielny rachunek netto.
  • false: dla każdej użytej waluty nie jest tworzony oddzielny wyciąg netto.
Nie dotyczy Nie
regNo

Numer rejestracyjny organizacji. Numer wpisany przez Ciebie dla tej usługi to wyświetlane na dole dokumentów rozliczeniowych.

Nie dotyczy Nie
selfBillingAsExchOrg

Jeśli włączone są faktury samodzielne, wskazuje, czy można je wymieniać organizacji non-profit. Możliwe wartości:

  • true: samodzielne faktury są włączone dla organizacji giełdy.
  • false: samodzielne faktury są wyłączone dla organizacji giełdy.
Nie dotyczy Nie
selfBillingForAllDev

Jeśli włączone są faktury samodzielne, wskazuje, czy są one włączone dla wszystkich deweloperów aplikacji. Domyślnie faktury własne są generowane tylko dla deweloperów aplikacji, którzy podpisał umowę z dostawcą interfejsu API. Możliwe wartości:

  • true: samodzielne faktury są włączone dla wszystkich deweloperów aplikacji.
  • false: samodzielne faktury nie są włączone dla wszystkich deweloperów aplikacji.
fałsz Nie
separateInvoiceForFees

Flaga, która określa, czy opublikowana jest osobna faktura za opłaty. Wartość może być jeden z tych elementów:

  • true: publikujemy oddzielną fakturę z opłatami.
  • false: osobna faktura nie jest publikowana z tytułu opłat.
fałsz Tak
status

Stan organizacji. Prawidłowe wartości to m.in.:

  • AKTYWNE: konto organizacji jest zarejestrowane w programie zarabiania i jest dostępne dla: i ich używanie.
  • NIEAKTYWNE: konto organizacji jest zarejestrowane w programie zarabiania, ale nie jest dostępnych do użytku.
Nie dotyczy Nie
supportedBillingType

Model płatności dewelopera używany do rozliczeń. Możliwe wartości:

  • PREPAID: deweloper płaci z góry za korzystanie z interfejsu API. Fundusze są odejmowane od salda dewelopera podczas używania usługi API. Deweloper musi utrzymywać saldo z przedpłaty wystarczające do zakupu usługi API.
  • POSTPAID: deweloper jest rozliczany miesięcznie (na podstawie faktury) za korzystanie z interfejsu API. usług. Deweloper płaci za korzystanie z usług API zgodnie z ustalonymi warunkami płatności przez abonamenty uwzględnione na fakturze.
  • BOTH obsługuje dowolny typ rozliczeń. Domyślna wartość to PREPAID.

Zapoznaj się z artykułem Konfigurowanie typów płatności przedpłaconych i po wykonaniu usługi przy użyciu interfejsu API.

PŁATNA Tak
taxModel

Uwaga: ma zastosowanie tylko wtedy, gdy masz skonfigurowane plany dzielenia się przychodami i chcesz w celu wygenerowania dokumentów rozliczeniowych.

Model podatkowy dla planów stawek dzielenia się przychodami, który określa typ wymaganych dokumentów rozliczeniowych.

Prawidłowe wartości to m.in.:

  • Ujawnione: dostawca interfejsu API działa jako ujawniony agent Google Play. Przychód brutto (w tym podatki od sprzedaży) pobierany od użytkownika wynosi i przekazywać je deweloperowi. Prowizja dostawcy interfejsu API jest pobierana od deweloper w formie faktury prowizyjnej. Dostawca interfejsu API nie obsługuje podatku od sprzedaży pobieranego od użytkownika, za który odpowiada programista. aby zgłosić podatek od sprzedaży.
  • Nieujawnione: dostawca interfejsu API działa jako nieujawniony agent dewelopera, odejmuje pobrany podatek od użytkowników i przekazuje go lokalnych urzędów skarbowych. Deweloper fakturuje dostawcę interfejsu API za przychody netto. należnej deweloperowi (bez podatków od sprzedaży i prowizji).
  • Hybrydowa: dostawca interfejsu API działa jako ujawniony agent Google Play. Dostawca interfejsu API opłaca jednak podatek od sprzedaży pobierany subskrybentów lokalnych urzędów skarbowych w imieniu dewelopera. Interfejs API przekazuje pozostałe przychody deweloperowi, a potem wystawia faktury prowizje.
Nie dotyczy Tak
taxNexus

Kraj, w którym organizacja jest zarejestrowana do celów podatkowych.

Nie dotyczy Nie
taxRegNo

numer identyfikacji podatkowej organizacji lub rejestracja podatku od towarów i usług (VAT), w odpowiednich przypadkach. Ta właściwość jest opcjonalna, ponieważ numer identyfikacji podatkowej lub Numer płatnika VAT nie jest dostępny we wszystkich krajach. Wpisany przez Ciebie numer jest wyświetlany na dole dokumentów rozliczeniowych.

Nie dotyczy Nie
transactionRelayURL

Adres URL innego systemu, do którego mogą być przekazywane transakcje, np. danych z magazynu.

Nie dotyczy Nie
timezone

Identyfikator strefy czasowej na potrzeby działań organizacji, na przykład Ameryka/Nowy_Jork lub Europa/Paryż. skróty strefy czasowej, np. UTC, EST (wschodnia) Obsługiwane są również czas standardowy) lub CET (czas środkowoeuropejski).

Nie dotyczy Tak

Zastępowanie ustawień profilu zarabiania w przypadku firmy lub dewelopera aplikacji

Zastąp ustawienia profilu zarabiania firmy lub dewelopera aplikacji za pomocą interfejsu użytkownika lub interfejsu API w sposób opisany w tych sekcjach: