Zarządzanie profilem organizacji

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Sekcje poniżej przedstawiają profil organizacji i opisują, jak możesz nim zarządzać za pomocą interfejsu i API.

Informacje o profilu organizacji

Podczas wstępnej konfiguracji zarabiania zespół ds. konfiguracji Apigee Edge konfiguruje profil Twojej organizacji.

Musisz edytować profil organizacji, aby odpowiednio dodać lub zaktualizować informacje o swojej organizacji. Może być na przykład konieczne zaktualizowanie 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, abonament lub oba), zgodnie z opisem w artykule Omówienie typu płatności.
• Cykl rozliczeniowy (opłata proporcjonalna lub miesiąc kalendarzowy)
• Waluta podstawowa
• Model podatkowy stosowany przez Twoją organizację

Możesz zarządzać profilem organizacji za pomocą interfejsu i API, jak opisano w poniższych sekcjach.

Poznawanie strony Profil organizacji

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

Edytowanie profilu organizacji przy użyciu 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 prowadzenia działalności.
4. W sekcji Podatki i waluta zmień te pola:

   Pole	Opis
   Model podatkowy	Uwaga: ma to zastosowanie tylko wtedy, gdy skonfigurujesz plany stawek dzielenia się przychodami i chcesz generować dokumenty rozliczeniowe. 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 dewelopera. Przychód brutto (w tym podatki od sprzedaży) pobrany od użytkownika jest przekazywany deweloperowi. Prowizja dostawcy interfejsu API jest pobierana od dewelopera w formie faktury prowizji. Dostawca interfejsu API nie zajmuje się podatkiem od sprzedaży pobieranym od użytkownika, a deweloper odpowiada za zgłaszanie tego podatku. Nieujawnione: dostawca interfejsu API działa jako nieujawniony agent dewelopera, odliczając podatek pobierany od użytkowników i odprowadzający go lokalnym urzędom podatkowym. Programista fakturuje dostawcy interfejsu API za udział w przychodach netto wynikający z działania dewelopera (mniejsze podatki od sprzedaży i prowizję dostawcy interfejsu API). Hybrydowy: dostawca interfejsu API działa jako ujawniony agent dewelopera. Jednak dostawca interfejsu API płaci w imieniu dewelopera podatek od sprzedaży pobrany od subskrybentów na rzecz lokalnego urzędu skarbowego. Dostawca interfejsu API przekazuje deweloperowi pozostałe przychody, a następnie wystawia faktury za opłaty prowizyjne.
   Waluta	Waluty obsługiwane przez Twoją organizację. W przypadku planów z dzieleniem się przychodami, arkuszem stawek i planem obejmującym tylko opłaty jest używana domyślna waluta. Podczas tworzenia arkusza stawek lub abonamentu korzystającego tylko z opłat możesz zmienić używaną walutę, wybierając ją z listy obsługiwanych walut. Opcjonalnie możesz ustawić minimalną kwotę doładowania, którą deweloperzy aplikacji mogą dodać do salda konta przedpłaconego dla każdej waluty. Aby dodać walutę: Kliknij Dodaj walutę. Wybierz walutę z menu w polu Waluta. Opcjonalnie w polu Minimalne doładowanie ustaw minimalną kwotę, którą deweloperzy aplikacji mogą dodać do salda konta przedpłaconego, w określonej walucie. Kliknij Dodaj. W razie potrzeby kliknij powiązany przycisk opcji, aby ustawić jako domyślną walutę. Aby dodać kolejne waluty, powtórz te kroki. Aby usunąć walutę, najedź kursorem na walutę, którą chcesz usunąć, i kliknij .

5. zarządzać warunkami zgodnie z opisem w artykule Zarządzanie Warunkami korzystania z usługi za pomocą interfejsu.
6. Kliknij Zapisz.

Zarządzanie profilem organizacji przy użyciu interfejsu API

Zarządzanie profilem organizacji za pomocą interfejsu API w sposób opisany w poniższych sekcjach.

Wyświetlanie profilu organizacji przy użyciu interfejsu API

Wyświetl 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ład odpowiedzi. Więcej informacji o dostępnych opcjach znajdziesz w artykule Właściwości konfiguracji profilu organizacji dla interfejsu 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 określić 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 tej obsługiwanej waluty, którą chcesz ustawić jako domyślną.

Na przykład to wywołanie interfejsu API zmienia 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 artykule Właściwości konfiguracji 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 typów rozliczeń przedpłaconych i abonamentowych za pomocą interfejsu API

Na kontach deweloperów można korzystać z tych form płatności: przedpłaconych, po wykonaniu usługi lub obu tych formach płatności.

W przypadku kont przedpłaconych deweloperzy płacą za używanie interfejsów API z góry. Środki są odejmowane od salda z przedpłaty 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 płatnych po wykonaniu usługi deweloperzy są rozliczani co miesiąc (na podstawie faktury) na koniec miesiąca. Deweloper płaci za korzystanie z usług API na podstawie warunków płatności określonych w abonamentach uwzględnionych na fakturze.

Aby skonfigurować typy płatności przedpłaconych i abonamentowych w swojej organizacji, ustaw we właściwości supportedBillingType jedną z tych wartości, aby wskazać prawidłowe typy rozliczeń: PREPAID, POSTPAID lub BOTH. Jeśli ustawisz wartość BOTH, domyślną wartością będzie PREPAID, gdy dodasz dewelopera aplikacji lub firmę. W takim przypadku możesz bezpośrednio ustawić typ rozliczeń dla firmy lub dewelopera aplikacji za pomocą interfejsu API, jak opisano w sekcji 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 w swojej organizacji, ustaw we właściwości billingCycle jedną z tych wartości:

• PRORATED: płatności są naliczane na podstawie liczby dni, przez które usługa API jest używana w miesiącu kalendarzowym.
• 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 następujących właściwości konfiguracji przy użyciu interfejsu API.

Nazwa	Opis	Domyślne	Wymagana?
address	Adres organizacji, który może zawierać ulicę, numer domu, miasto, stan, kod pocztowy, kraj oraz informację, czy jest to podstawowy 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. Możliwe wartości: PROPONOWANE: płatności są naliczane na podstawie liczby dni, przez które usługa API była używana w miesiącu kalendarzowym. CALENDAR_MONTH: płatności są realizowane co miesiąc. Zobacz Konfigurowanie cyklu rozliczeniowego przy użyciu interfejsu API.	Nie dotyczy	Tak
country	Kod ISO 3166-2 oznaczający kraj, w którym działa organizacja, np. BR w przypadku Brazylii.	Nie dotyczy	Tak
currency	Kod ISO 4217 oznaczający walutę podstawową lub księgową używaną w organizacji (np. PLN w przypadku dolara amerykańskiego). W przypadku planów dzielenia się przychodami: w planie używana jest określona waluta. W przypadku planów arkusza stawek (modelu obciążenia) obowiązuje tak samo jak w przypadku planów dzielenia się przychodami, ale możesz zmienić ustawienie waluty na dowolną walutę obsługiwaną przez organizację. W przypadku abonamentó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 zarejestrowanych przez usługi interfejsu API dla Twoich usług interfejsu API. Wartość może być jedną z tych: 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 to być jedna z tych wartości: true: przychody są obliczane na podstawie wartości netto. false: przychody nie są wyliczane na podstawie netto.	Nie dotyczy	Nie
hasSelfBilling	Flaga, która skieruje zarabianie do generowania faktury rozliczanej samodzielnie zamiast zestawienia przychodów. Faktura samoobsługowa to dokument finansowy ze szczegółowymi informacjami na temat kwoty należnej deweloperowi aplikacji. Pełni ona funkcję faktury dla dostawcy interfejsu API w imieniu dewelopera aplikacji. Możliwe wartości: true: powoduje generowanie faktur do samodzielnego rozliczenia zamiast wyciągów z udziału w przychodach. false: wyłącza faktury rozliczane samodzielnie.	Nie dotyczy	Nie
hasSeparateInvoiceForProduct	Flaga określająca, czy za każdą usługę API jest generowana oddzielna faktura. Możliwe wartości: true: dla każdej usługi API generowana jest oddzielna faktura. false: oddzielna faktura nie jest generowana dla każdej usługi API.	Nie dotyczy	Nie
id	Identyfikator organizacji.	Nie dotyczy	Nie
issueNettingStmt	Flaga określająca, czy podczas tworzenia dokumentów rozliczeniowych generowane jest zestawienie operacji netto. Możliwe wartości: true: wyciąg dotyczący bilansu bilansowego jest generowany podczas tworzenia dokumentów rozliczeniowych. false: wyciąg bilansowy nie jest generowany podczas tworzenia dokumentów rozliczeniowych.	Nie dotyczy	Nie
logoUrl	Adres URL logo organizacji.	Nie dotyczy	Nie
name	Nazwa organizacji.	Nie dotyczy	Tak
netPaymentAdviceNote	Notatka z zaleceniem płatności netto.	Nie dotyczy	Nie
nettingStmtPerCurrency	Flaga określająca, czy w przypadku każdej używanej waluty generowana jest oddzielna instrukcja zapłaty. Możliwe wartości: true: dla każdej używanej waluty generowane jest osobne zestawienie operacji netto. false: oddzielne wyciągi netto nie są generowane dla każdej użytej waluty.	Nie dotyczy	Nie
regNo	Numer rejestracyjny organizacji. Numer wpisany dla tej usługi jest wyświetlany u dołu dokumentów rozliczeniowych.	Nie dotyczy	Nie
selfBillingAsExchOrg	Jeśli masz włączone samodzielne rozliczanie faktur, wskazuje, czy jest włączone dla organizacji giełd. Możliwe wartości: true: samodzielne rozliczanie faktur jest włączone w przypadku organizacji giełdy. false: samodzielne rozliczanie faktur nie jest włączone w przypadku organizacji giełdowych.	Nie dotyczy	Nie
selfBillingForAllDev	Jeśli faktury za samodzielne rozliczenia są włączone, wskazuje, czy są one włączone dla wszystkich deweloperów aplikacji. Domyślnie faktury rozliczane samodzielnie są generowane tylko dla deweloperów aplikacji, którzy podpisali umowę z dostawcą interfejsu API. Możliwe wartości: true: samodzielne rozliczanie faktur jest włączone dla wszystkich deweloperów aplikacji. false: samodzielne rozliczanie faktur nie jest włączone dla wszystkich deweloperów aplikacji.	false	Nie
separateInvoiceForFees	Flaga określająca, czy została opublikowana osobna faktura za opłaty. Możliwe wartości: true: publikowana jest oddzielna faktura za opłaty. false: oddzielna faktura nie została opublikowana z tytułu opłat.	false	Tak
status	Stan organizacji. Prawidłowe wartości to m.in.: AKTYWNE: konto organizacji jest zarejestrowane w funkcji zarabiania i dostępne do użycia. NIEAKTYWNE: konto organizacji jest zarejestrowane w programie zarabiania, ale nie można z niego korzystać.	Nie dotyczy	Nie
supportedBillingType	Model płatności używany przez dewelopera do rozliczeń. Możliwe wartości: PRZEDPŁATA: deweloper płaci z góry za korzystanie z usługi API. Gdy użytkownik korzysta z interfejsu API, środki są odliczane od salda dewelopera. Deweloper musi utrzymywać saldo z przedpłaty wystarczające do zakupu produktu API. POSTPAID: deweloper jest rozliczany co miesiąc (na fakturze) za korzystanie z usług API. Deweloper płaci za korzystanie z usług API zgodnie z warunkami płatności określonymi w abonamentach uwzględnionych na fakturze. BOTH (Jedno i drugie): obsługuje oba typy płatności. Domyślna wartość to PREPAID. Zapoznaj się z artykułem Konfigurowanie metod płatności przedpłaconych i opłacanych z góry przy użyciu interfejsu API.	PŁATNA	Tak
taxModel	Uwaga: ma to zastosowanie tylko wtedy, gdy skonfigurujesz plany stawek dzielenia się przychodami i chcesz generować dokumenty rozliczeniowe. 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 dewelopera. Przychód brutto (w tym podatki od sprzedaży) pobrany od użytkownika jest przekazywany deweloperowi. Prowizja dostawcy interfejsu API jest pobierana od dewelopera w formie faktury prowizji. Dostawca interfejsu API nie zajmuje się podatkiem od sprzedaży pobieranym od użytkownika, a deweloper odpowiada za zgłaszanie tego podatku. Nieujawnione: dostawca interfejsu API działa jako nieujawniony agent dewelopera, odliczając podatek pobierany od użytkowników i odprowadzający go lokalnym urzędom podatkowym. Programista fakturuje dostawcy interfejsu API za udział w przychodach netto wynikający z działania dewelopera (mniejsze podatki od sprzedaży i prowizję dostawcy interfejsu API). Hybrydowy: dostawca interfejsu API działa jako ujawniony agent dewelopera. Jednak dostawca interfejsu API płaci w imieniu dewelopera podatek od sprzedaży pobrany od subskrybentów na rzecz lokalnego urzędu skarbowego. Dostawca interfejsu API przekazuje deweloperowi pozostałe przychody, a następnie wystawia faktury za opłaty prowizyjne.	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 VAT (w stosownych przypadkach). Ta właściwość jest opcjonalna, ponieważ numer rejestracji podatkowej lub numer płatnika VAT nie obowiązują we wszystkich krajach. Liczba podana dla tego parametru jest wyświetlana u dołu dokumentów rozliczeniowych.	Nie dotyczy	Nie
transactionRelayURL	Adres URL innego systemu, do którego mogą być przekazywane transakcje, np. hurtowni danych.	Nie dotyczy	Nie
timezone	Identyfikator strefy czasowej, w której działa organizacja, np. America/New_York lub Europa/Paryż. Obsługiwane są też skróty stref czasowych, np. UTC, EST (czas wschodni standardowy) lub CET (czas środkowoeuropejski).	Nie dotyczy	Tak

Zastępowanie ustawień profilu zarabiania firmy lub dewelopera aplikacji

zastąpić ustawienia profilu zarabiania na potrzeby firmy lub dewelopera aplikacji za pomocą interfejsu użytkownika albo interfejsu API, jak opisano w tych sekcjach:

• Zarządzanie atrybutami niestandardowymi na potrzeby dewelopera aplikacji
• Zarządzanie firmami i deweloperami aplikacji
• Zarządzanie deweloperami aplikacji