Zarządzanie profilem organizacji

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

W kolejnych sekcjach przedstawiamy profil organizacji i opisujemy, jak nim zarządzać za pomocą interfejsu i interfejsu API.

Informacje o profilu organizacji

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

Aby dodać lub zaktualizować informacje o organizacji, musisz edytować jej profil. Może być konieczne na przykład zaktualizowanie typu rozliczeń, ustawień waluty lub modelu podatkowego.

Skonfiguruj podstawowe informacje o organizacji, takie jak:

  • Nazwa, adres i kraj prowadzenia działalności organizacji
  • Typ rozliczeń (przedpłata, płatność po wykonaniu usługi lub oba typy), zgodnie z opisem w artykule Typy rozliczeń
  • Cykl rozliczeniowy (proporcjonalny lub miesiąc kalendarzowy)
  • Waluta podstawowa
  • Model podatkowy używany przez organizację

Profilem organizacji możesz zarządzać za pomocą interfejsu i interfejsu API, jak opisano w sekcjach poniżej.

Poznawanie strony Profil organizacji

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

Edge

Aby otworzyć stronę Profil organizacji w interfejsie Edge:

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

Wyświetli się strona Profil organizacji.

Jak widać na ilustracji, na stronie profilu organizacji możesz:

Classic Edge (Private Cloud)

Aby otworzyć stronę Profil organizacji w klasycznym interfejsie Edge:

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

Wyświetli się strona Profil organizacji.

Na stronie Profil organizacji możesz:

Edytowanie profilu organizacji w interfejsie

Aby edytować profil organizacji w interfejsie:

  1. Otwórz stronę profilu organizacji.
  2. Kliknij Edytuj.
  3. W sekcji Nazwa i informacje edytuj nazwę organizacji i kraj prowadzenia działalności.
  4. W sekcji Podatki i waluta zmień te pola:
    Pole Opis
    Model podatkowy

    Uwaga: dotyczy tylko sytuacji, gdy skonfigurujesz plany stawek dzielenia się przychodami i chcesz generować dokumenty rozliczeniowe.

    Model podatkowy dla abonamentów z udziałem w przychodach, który określa typ wymaganych dokumentów rozliczeniowych.

    Prawidłowe wartości:

    • Ujawnione: dostawca interfejsu API działa jako ujawniony przedstawiciel dewelopera. Przychody brutto (wraz z podatkiem od sprzedaży) uzyskane od użytkownika są przekazywane deweloperowi. Prowizja dostawcy interfejsu API jest pobierana od dewelopera w formie faktury prowizyjnej. Dostawca interfejsu API nie obsługuje podatku od sprzedaży pobranego od użytkownika końcowego, a obowiązek zgłoszenia podatku od sprzedaży spoczywa na deweloperze.
    • Nieujawniony: dostawca interfejsu API działa jako nieujawniony przedstawiciel dewelopera, odlicza podatek pobrany od użytkowników i przekazuje go lokalnym organom podatkowym. Deweloper wystawia dostawcy interfejsu API fakturę za udział w przychodach netto należny deweloperowi (pomniejszony o podatki od sprzedaży i prowizję dostawcy interfejsu API).
    • Hybrydowy: dostawca interfejsu API działa jako ujawniony przedstawiciel dewelopera. Dostawca interfejsu API płaci jednak podatek od sprzedaży pobrany od subskrybentów lokalnym organom podatkowym w imieniu dewelopera. Dostawca interfejsu API przekazuje pozostałe przychody deweloperowi, a następnie wystawia fakturę za prowizję.
    Waluta

    Waluty obsługiwane przez Twoją organizację. W przypadku planów z udziałem w przychodach, cennikiem i opłatami domyślną walutą jest waluta planu cenowego. Gdy tworzysz cennik lub plan oparty wyłącznie na opłatach, możesz zmienić walutę, wybierając ją z listy obsługiwanych walut. Opcjonalnie możesz ustawić minimalną kwotę doładowania, jaką deweloperzy aplikacji mogą dodać do salda konta przedpłaconego w przypadku każdej waluty.

    Aby dodać walutę:

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

    Aby usunąć walutę, najedź na nią kursorem i kliknij .
  5. Zarządzaj warunkami, jak opisano w artykule Zarządzanie warunkami za pomocą interfejsu.
  6. Kliknij Zapisz.

Zarządzanie profilem organizacji za pomocą interfejsu API

Zarządzaj profilem organizacji za pomocą interfejsu API zgodnie z opisem w sekcjach poniżej.

Wyświetlanie profilu organizacji za pomocą interfejsu API

Wyświetl profil organizacji, wysyłając żądanie GET do adresu /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ład odpowiedzi. Więcej informacji o wyświetlanych opcjach 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 za pomocą 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 te, które edytujesz.

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

Na przykład to wywołanie interfejsu API aktualizuje currency na USD, a ustawienie modelu podatkowego na HYBRID (zaktualizowane pola są wyróżnione w przykładzie). Więcej informacji o wyświetlanych opcjach znajdziesz w sekcji Właściwości konfiguracji profilu organizacji w interfejsie 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 typów rozliczeń przedpłaconych i po wykonaniu usługi za pomocą interfejsu API

Konta deweloperów można skonfigurować tak, aby korzystały z tych typów rozliczeń: przedpłata, płatność po wykonaniu usługi lub oba te typy.

W przypadku kont przedpłaconych deweloperzy płacą z góry za korzystanie z Twoich interfejsów API. Środki są potrącane z salda z przedpłaty dewelopera, które jest utrzymywane przez zintegrowanego dostawcę usług płatniczych. Deweloper musi mieć wystarczające saldo z przedpłaty, aby kupić interfejsy API.

W przypadku kont z płatnościami odroczonymi deweloperzy otrzymują na koniec miesiąca fakturę i są rozliczani co miesiąc. Deweloper płaci za korzystanie z usług API zgodnie z warunkami płatności określonymi w planach uwzględnionych na fakturze.

Aby skonfigurować typy płatności z góry i z dołu dla organizacji, ustaw wartość właściwości supportedBillingType na jedną z tych wartości, aby wskazać, które typy płatności są prawidłowe: PREPAID, POSTPAID lub BOTH. Jeśli ustawisz wartość na BOTH, domyślną wartością będzie PREPAID, gdy dodasz dewelopera aplikacji lub firmę. W takim przypadku możesz jawnie ustawić typ rozliczeń dla firmy lub dewelopera aplikacji za pomocą interfejsu API zgodnie z opisem w artykule 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 dla organizacji, ustaw w atrybucie billingCycle jedną z tych wartości:

  • PRORATED: rozliczenia są oparte na liczbie dni, w których produkt API jest używany w danym miesiącu kalendarzowym.
  • CALENDAR_MONTH: Opłaty 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 w interfejsie API

Profil organizacji umożliwia ustawienie tych właściwości konfiguracyjnych za pomocą interfejsu API.

Nazwa Opis Domyślny Wymagany?
address

Adres organizacji, który może zawierać ulicę i numer domu, miasto, stan, kod pocztowy, kraj oraz informację, czy jest to główny adres 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. Wartość może być jedną z tych opcji:

  • PROPORCJONALNE: rozliczenia są oparte na liczbie dni, w których produkt interfejsu API jest używany w miesiącu kalendarzowym.
  • CALENDAR_MONTH: rozliczenia są dokonywane co miesiąc.

Więcej informacji znajdziesz w artykule Konfigurowanie cyklu rozliczeniowego za pomocą interfejsu API.

Nie dotyczy Tak
country

Kod ISO 3166-2 kraju, w którym organizacja prowadzi działalność, np. BR w przypadku Brazylii.

 Nie dotyczy Tak
currency

Kod ISO 4217 „podstawowej” lub waluty rozliczeniowej używanej przez organizację (np. PLN w przypadku złotego).

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

W przypadku planów z cennikiem (model rozliczeń): obowiązują te same zasady co w przypadku planów z udziałem w przychodach. Możesz jednak zmienić ustawienie waluty na dowolną walutę obsługiwaną przez organizację.

W przypadku pakietów obejmujących tylko opłaty: możesz zmienić ustawienie waluty na dowolną walutę obsługiwaną przez organizację.

 Nie dotyczy Tak
description

Krótki opis organizacji.

 Nie dotyczy Nie
hasBillingAdjustment

Flaga określająca, czy korekty są włączone. Jeśli ta opcja jest włączona, możesz wprowadzać zmiany w szczegółach ruchu rejestrowanych przez usługi API w przypadku Twoich produktów API. Wartość może być jedną z tych opcji:

  • 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 wartości netto. Może mieć jedną z tych wartości:

  • true: przychody są obliczane na podstawie wartości netto;
  • false: przychody nie są oparte na wartości netto.
 Nie dotyczy Nie
hasSelfBilling

Flaga, która kieruje zarabianie na generowanie faktury z samofakturowaniem zamiast wyciągu z udziału w przychodach. Faktura wystawiana samodzielnie to dokument finansowy, który zawiera szczegółowe informacje o kwocie należnej deweloperowi aplikacji. Działa ona jako faktura dla dostawcy interfejsu API w imieniu dewelopera aplikacji. Wartość może być jedną z tych opcji:

  • true: generuje faktury z samofakturowaniem zamiast wyciągów z udziału w przychodach.
  • false: wyłącza faktury wystawiane samodzielnie.
 Nie dotyczy Nie
hasSeparateInvoiceForProduct

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

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

Identyfikator organizacji.

 Nie dotyczy Nie
issueNettingStmt

Flaga określająca, czy podczas tworzenia dokumentów rozliczeniowych generowane jest zestawienie rozliczeń. Wartość może być jedną z tych opcji:

  • true: Wyciąg z rozliczeń jest generowany podczas tworzenia dokumentów rozliczeniowych.
  • false: Podczas tworzenia dokumentów rozliczeniowych nie jest generowane zestawienie kompensacyjne.
 Nie dotyczy Nie
logoUrl

Adres URL logo organizacji.

 Nie dotyczy Nie
name

Nazwa organizacji.

 Nie dotyczy Tak
netPaymentAdviceNote

Awizo płatności netto.

 Nie dotyczy Nie
nettingStmtPerCurrency

Flaga określająca, czy dla każdej użytej waluty jest generowany osobny wyciąg z rozliczeń. Wartość może być jedną z tych opcji:

  • true: dla każdej użytej waluty generowane jest osobne zestawienie kompensat.
  • false: dla każdej używanej waluty nie jest generowany osobny wyciąg z rozliczeń.
 Nie dotyczy Nie
regNo

Numer rejestracyjny organizacji. Wpisany tu numer jest wyświetlany u dołu dokumentów rozliczeniowych.

 Nie dotyczy Nie
selfBillingAsExchOrg

Jeśli faktury z samofakturowaniem są włączone, wskazuje, czy są włączone w przypadku organizacji wymiany. Wartość może być jedną z tych opcji:

  • true: faktury wystawiane samodzielnie są włączone w przypadku organizacji wymiany;
  • false: Faktury wystawiane samodzielnie nie są dostępne dla organizacji wymiany.
 Nie dotyczy Nie
selfBillingForAllDev

Jeśli faktury z samofakturowania są włączone, wskazuje, czy są one włączone dla wszystkich deweloperów aplikacji. Domyślnie faktury z samofakturowaniem są generowane tylko dla deweloperów aplikacji, którzy podpisali umowę z dostawcą interfejsu API. Wartość może być jedną z tych opcji:

  • true: faktury z samofakturowaniem są dostępne dla wszystkich deweloperów aplikacji.
  • false: Faktury z samofakturowaniem nie są włączone dla wszystkich deweloperów aplikacji.
 fałsz Nie
separateInvoiceForFees

Flaga określająca, czy opłaty są publikowane na osobnej fakturze. Wartość może być jedną z tych opcji:

  • true: Opłaty są publikowane na osobnej fakturze.
  • false: Za opłaty nie jest publikowana osobna faktura.
 fałsz Tak
status

Stan organizacji. Prawidłowe wartości:

  • AKTYWNE: konto organizacji jest zarejestrowane w programie zarabiania i można z niego korzystać.
  • NIEAKTYWNE: konto organizacji jest zarejestrowane w programie zarabiania, ale nie jest dostępne do użytku.
 Nie dotyczy Nie
supportedBillingType

Model płatności dewelopera używany do rozliczeń. Wartość może być jedną z tych opcji:

  • PREPAID: deweloper płaci z góry za korzystanie z usługi API. Środki są odliczane od salda dewelopera, gdy używany jest produkt API. Deweloper musi utrzymywać saldo z przedpłaty wystarczające do zakupu produktu API.
  • POSTPAID Deweloper otrzymuje co miesiąc fakturę za korzystanie z usług API. Deweloper płaci za korzystanie z usług API zgodnie z warunkami płatności określonymi w planach uwzględnionych na fakturze.
  • BOTH: obsługuje oba typy rozliczeń. Domyślna wartość to PREPAID.

Zobacz Konfigurowanie typów rozliczeń przedpłaconych i po wykonaniu usługi za pomocą interfejsu API.

PRZEDPŁACONA Tak
taxModel

Uwaga: dotyczy tylko sytuacji, gdy skonfigurujesz plany stawek dzielenia się przychodami i chcesz generować dokumenty rozliczeniowe.

Model podatkowy dla abonamentów z udziałem w przychodach, który określa typ wymaganych dokumentów rozliczeniowych.

Prawidłowe wartości:

  • Ujawnione: dostawca interfejsu API działa jako ujawniony przedstawiciel dewelopera. Przychody brutto (wraz z podatkiem od sprzedaży) uzyskane od użytkownika są przekazywane deweloperowi. Prowizja dostawcy interfejsu API jest pobierana od dewelopera w formie faktury prowizyjnej. Dostawca interfejsu API nie obsługuje podatku od sprzedaży pobranego od użytkownika końcowego, a obowiązek zgłoszenia podatku od sprzedaży spoczywa na deweloperze.
  • Nieujawniony: dostawca interfejsu API działa jako nieujawniony przedstawiciel dewelopera, odlicza podatek pobrany od użytkowników i przekazuje go lokalnym organom podatkowym. Deweloper wystawia dostawcy interfejsu API fakturę za udział w przychodach netto należny deweloperowi (pomniejszony o podatki od sprzedaży i prowizję dostawcy interfejsu API).
  • Hybrydowy: dostawca interfejsu API działa jako ujawniony przedstawiciel dewelopera. Dostawca interfejsu API płaci jednak podatek od sprzedaży pobrany od subskrybentów lokalnym organom podatkowym w imieniu dewelopera. Dostawca interfejsu API przekazuje pozostałe przychody deweloperowi, a następnie wystawia fakturę za prowizję.
 Nie dotyczy Tak
taxNexus

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

 Nie dotyczy Nie
taxRegNo

Numer rejestracji podatkowej organizacji lub numer rejestracji na potrzeby podatku od towarów i usług (VAT), jeśli dotyczy. Ten atrybut jest opcjonalny, ponieważ numer rejestracji podatkowej lub numer płatnika VAT nie obowiązuje we wszystkich krajach. Wpisana tu liczba jest wyświetlana u dołu dokumentów rozliczeniowych.

 Nie dotyczy Nie
transactionRelayURL

Adres URL innego systemu, do którego można przekazywać transakcje, np. hurtowni danych.

 Nie dotyczy Nie
timezone

Identyfikator strefy czasowej, w której działa organizacja, np. America/New_York lub Europe/Paris. Obsługiwane są też skróty stref czasowych, takie jak UTC, EST (czas wschodni standardowy) czy CET (czas środkowoeuropejski).

 Nie dotyczy Tak

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

Zastąp ustawienia profilu zarabiania w przypadku firmy lub dewelopera aplikacji za pomocą interfejsu lub interfejsu API zgodnie z opisem w tych sekcjach: