Zarządzanie profilem organizacji

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

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

Informacje o profilu organizacji

W ramach początkowej konfiguracji funkcji zarabiania zespół konfiguracji Apigee Edge skonfiguruje profil Twojej organizacji.

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

Skonfiguruj podstawowe informacje o organizacji, takie jak:

• Nazwa, adres i kraj działalności organizacji
• Typ rozliczenia (przedpłacony, po wykonaniu usługi lub oba), zgodnie z opisem w artykule Typ rozliczenia.
• Cykl rozliczeniowy (proporcjonalny lub miesiąc kalendarzowy)
• Waluta podstawowa
• Model podatkowy używany przez Twoją organizację

Profilem organizacji możesz zarządzać za pomocą interfejsu użytkownika i interfejsu API w sposób opisany w sekcjach poniżej.

Poznawanie strony Profil organizacji

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

Edytowanie profilu organizacji za pomocą interfejsu

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

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

   Pole	Opis
   Model podatkowy	Uwaga: dotyczy to tylko sytuacji, gdy masz skonfigurowane abonamenty z udziałem w przychodach i chcesz wygenerować dokumenty rozliczeniowe. Model podatkowy dla planów stawek w ramach dzielenia się przychodami, który określa typ wymaganych dokumentów rozliczeniowych. Prawidłowe wartości: Ujawniony: dostawca interfejsu API działa jako ujawniony przedstawiciel dewelopera. Przychody brutto (w tym podatki od sprzedaży) zebrane od użytkownika są przekazywane deweloperowi. Prowizja dostawcy interfejsu API jest pobierana od dewelopera w formie faktury prowizji. Dostawca interfejsu API nie obsługuje podatku od sprzedaży pobieranego od użytkownika końcowego. Za jego zgłaszanie odpowiada deweloper. Nieujawniony: dostawca interfejsu API działa jako nieujawniony agent dewelopera, który odlicza podatek od użytkowników i wpłaca go do lokalnych organów podatkowych. Deweloperzy wystawiają dostawcom interfejsu API faktury za udział w przychodach netto (pomniejszony o podatek od sprzedaży i prowizję dostawcy interfejsu API). Hybrydowy: dostawca interfejsu API działa jako ujawniony przedstawiciel dewelopera. Jednak dostawca interfejsu API płaci podatek od sprzedaży pobrany od subskrybentów lokalnym organom podatkowym w imieniu dewelopera. Dostawca interfejsu API przekazuje pozostałe przychody deweloperowi, a potem wystawia fakturę za prowizję.
   Waluta	waluty obsługiwane przez Twoją organizację. W przypadku planów z dzieleniem się przychodami, cennika i opłat tylko, domyślna waluta jest używana do planu cenowego. Podczas tworzenia cennika lub planu z opłatami możesz wybrać walutę, korzystają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ę: Kliknij Dodaj walutę. W polu Waluta wybierz walutę z menu. Opcjonalnie w polu Minimalny doładunek możesz ustawić minimalną kwotę, jaką deweloperzy aplikacji mogą dodać do salda konta przedpłaconego w wybranej walucie. Kliknij Dodaj. Jeśli chcesz, ustaw ją jako domyślną walutę, klikając odpowiedni przycisk radiowy. Aby dodać kolejne waluty, powtórz te czynności. Aby usunąć walutę, najedź na nią kursorem i kliknij .

5. Zarządzaj warunkami korzystania z usługi zgodnie z opisem w artykule Zarządzanie warunkami korzystania z usługi za pomocą interfejsu użytkownika.
6. Kliknij Zapisz.

Zarządzanie profilem organizacji za pomocą interfejsu API

Zarządzaj profilem organizacji za pomocą interfejsu API zgodnie z opisem w następnych sekcjach.

Wyświetlanie profilu organizacji za pomocą interfejsu API

Aby wyświetlić profil organizacji, wyślij żą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 przedstawiamy przykład odpowiedzi. Więcej informacji o wyświetlanych opcjach znajdziesz w artykule 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 adresu /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ść parametru currency na kod waluty ISO 4217 obsługiwanej waluty, którą chcesz ustawić jako domyślną.

Na przykład to wywołanie interfejsu API zmienia wartość pola currency na USD, a ustawienie modelu podatkowego na HYBRID (zaktualizowane pola są wyróżnione na przykładzie). Więcej informacji o wyświetlanych opcjach znajdziesz w artykule 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ń z przedpłatą i pobraniem za pomocą interfejsu API

Konta dewelopera można skonfigurować tak, aby korzystały z jednego z tych typów rozliczeń: z przedpłatą, z obciążeniem karty lub z obu tych opcji.

W przypadku kont przedpłaconych deweloperzy płacą z góry za korzystanie z interfejsów API. Środki są potrącane z salda przedpłaconego dewelopera, które jest zarządzane przez zintegrowanego dostawcę płatności. Deweloper musi mieć saldo przedpłacone wystarczające na zakup interfejsów API.

W przypadku kont z rozliczeniami odroczonymi deweloperzy są obciążani co miesiąc (za pomocą faktury) pod koniec miesiąca. Deweloperzy płacą za korzystanie z produktów API na podstawie warunków płatności określonych w planach podanych na fakturze.

Aby skonfigurować w organizacji typy płatności z przedpłatą i po fakcie, ustaw właściwość supportedBillingType na jedną z tych wartości: PREPAID, POSTPAID lub BOTH. Jeśli ustawisz wartość na BOTH, podczas dodawania dewelopera aplikacji lub firmy zostanie zastosowana domyślna wartość PREPAID. W takim przypadku możesz 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ą dokonywane na podstawie liczby dni, w których usługa interfejsu API była używana w danym miesiącu kalendarzowym.
• CALENDAR_MONTH: rozliczenia są dokonywane 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 dla interfejsu API

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

Nazwa	Opis	Domyślny	Wymagany?
address	adres organizacji, który może zawierać ulicę, miasto, województwo, kod pocztowy, kraj oraz wskazanie, czy jest to adres główny 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 rozliczeniowy. Wartość może być jedną z tych wartości: PROPORCJONALNY: rozliczenie jest oparte na liczbie dni, przez które produkt interfejsu API był używany w danym miesiącu kalendarzowym. CALENDAR_MONTH: płatności są naliczane co miesiąc. Zobacz artykuł Konfigurowanie cyklu rozliczeniowego za pomocą interfejsu API.	Nie dotyczy	Tak
country	Kod ISO 3166-2 kraju, w którym działa organizacja, na przykład BR dla Brazylii.	Nie dotyczy	Tak
currency	kod ISO 4217 „podstawowej” waluty księgowej, której używa organizacja (np. USD w przypadku dolara amerykańskiego). W przypadku planów z udziałem w przychodach: do Twojego planu jest używana określona waluta. W przypadku planów z taryfą (modelem opłat): te same zasady obowiązują jak w przypadku planów z udostępnianiem przychodów. Możesz jednak zmienić ustawienie waluty na dowolną walutę obsługiwaną przez organizację. W przypadku planów z opłatami: 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ć korekty dotyczące szczegółów ruchu rejestrowanych przez usługi interfejsu API w przypadku Twoich produktów interfejsu API. Wartość może być jedną z tych: Prawda: korekty są włączone. fałsz: korekty nie są włączone.	Nie dotyczy	Nie
hasBroker	Flaga określająca, czy przychody są obliczane na podstawie wartości netto. Wartość może być jedną z tych: true: przychody są obliczane na podstawie wartości netto. false: Revenue is not based on net.	Nie dotyczy	Nie
hasSelfBilling	Flaga, która kieruje Monetyzację do wygenerowania faktury samoobliczającej zamiast wyciągu z konta z podziałem przychodów. Faktura samoobsługowa to dokument finansowy, który zawiera szczegółowe informacje o kwocie należnej deweloperowi aplikacji. Jest ona wystawiana przez dostawcę interfejsu API w imieniu dewelopera aplikacji. Wartość może być 1 z tych wartości: true: zamiast wyciągów z udziałem w przychodach generuje faktury samoobsługowe. false: wyłącza faktury samoobsługowe.	Nie dotyczy	Nie
hasSeparateInvoiceForProduct	Flaga określająca, czy dla każdego produktu interfejsu API jest tworzona osobna faktura. Wartość może być jedną z tych wartości: true: dla każdego produktu interfejsu API generowana jest osobna faktura. false: nie generuje osobnej faktury za każdy produkt API.	Nie dotyczy	Nie
id	Identyfikator organizacji.	Nie dotyczy	Nie
issueNettingStmt	Flaga określająca, czy podczas tworzenia dokumentów rozliczeniowych ma być generowane zestawienie kompensacyjne. Wartość może być 1 z tych wartości: true: podczas tworzenia dokumentów rozliczeniowych generowany jest wyciąg uzgadniający. false: podczas tworzenia dokumentów rozliczeniowych nie jest generowane oświadczenie o wzajemnym rozliczeniu.	Nie dotyczy	Nie
logoUrl	Adres URL logo organizacji.	Nie dotyczy	Nie
name	Nazwa organizacji.	Nie dotyczy	Tak
netPaymentAdviceNote	Net payment advice note.	Nie dotyczy	Nie
nettingStmtPerCurrency	Flaga określająca, czy dla każdej używanej waluty ma być generowane oddzielne rozliczenie netting. Wartość może być 1 z tych wartości: true: w przypadku każdej użytej waluty generowane jest osobne zestawienie sald. false: nie jest generowany oddzielny wyciąg salda dla każdej używanej waluty.	Nie dotyczy	Nie
regNo	numer rejestracyjny organizacji. Numer podany dla tej usługi będzie widoczny na dole dokumentów rozliczeniowych.	Nie dotyczy	Nie
selfBillingAsExchOrg	Jeśli faktury z samodzielnym wystawianiem są włączone, wskazuje, czy są one włączone dla organizacji wymiany. Wartość może być 1 z tych wartości: true: faktury z samoobsługowym wystawianiem są włączone w przypadku organizacji giełdowych. false: W przypadku organizacji wymiany nie można wystawiać faktur samodzielnie.	Nie dotyczy	Nie
selfBillingForAllDev	Jeśli faktury samoobsługowe są włączone, wskazuje, czy są one włączone dla wszystkich deweloperów aplikacji. Domyślnie faktury samoobsługowe są generowane tylko w przypadku deweloperów aplikacji, którzy podpisali umowę z dostawcą interfejsu API. Wartość może być 1 z tych wartości: true: faktury z samoobsługowym wystawianiem są włączone dla wszystkich deweloperów aplikacji. fałsz: faktury z samoobsługowym wystawianiem nie są dostępne 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: oddzielna faktura jest publikowana w przypadku opłat. false: Separate invoice is not published for fees.	fałsz	Tak
status	Stan organizacji. Prawidłowe wartości: AKTYWNE: konto organizacji jest zarejestrowane w systemie zarabiania i jest dostępne do użytku. NIEAKTYWNE: konto organizacji jest zarejestrowane w systemie zarabiania, ale nie można z niego korzystać.	Nie dotyczy	Nie
supportedBillingType	Model płatności dla deweloperów używany do rozliczeń. Wartość może być jedną z tych wartości: PREPAID deweloper płaci z góry za korzystanie z interfejsu API. Środki są pobierane z salda dewelopera, gdy korzysta on z interfejsu API. Deweloperzy muszą mieć saldo przedpłacone wystarczające na zakup produktu API. POSTPAID: miesięcznie (na podstawie faktury) obciążamy dewelopera opłatą za korzystanie z produktów interfejsu API. Deweloper płaci za korzystanie z produktów API na podstawie warunków płatności określonych w planach zawartych na fakturze. Oba: obsługa dowolnego typu rozliczeń. Domyślna wartość to PREPAID. Zapoznaj się z artykułem Konfigurowanie typów rozliczeń z przedpłatą i po użyciu karty płatniczej za pomocą interfejsu API.	PREPAID	Tak
taxModel	Uwaga: dotyczy to tylko sytuacji, gdy masz skonfigurowane abonamenty z udziałem w przychodach i chcesz wygenerować dokumenty rozliczeniowe. Model podatkowy dla planów stawek w ramach dzielenia się przychodami, który określa typ wymaganych dokumentów rozliczeniowych. Prawidłowe wartości: Ujawniony: dostawca interfejsu API działa jako ujawniony przedstawiciel dewelopera. Przychody brutto (w tym podatki od sprzedaży) zebrane od użytkownika są przekazywane deweloperowi. Prowizja dostawcy interfejsu API jest pobierana od dewelopera w formie faktury prowizji. Dostawca interfejsu API nie obsługuje podatku od sprzedaży pobieranego od użytkownika końcowego. Za jego zgłaszanie odpowiada deweloper. Nieujawniony: dostawca interfejsu API działa jako nieujawniony agent dewelopera, który odlicza podatek od użytkowników i wpłaca go do lokalnych organów podatkowych. Deweloperzy wystawiają dostawcom interfejsu API faktury za udział w przychodach netto (pomniejszony o podatek od sprzedaży i prowizję dostawcy interfejsu API). Hybrydowy: dostawca interfejsu API działa jako ujawniony przedstawiciel dewelopera. Jednak dostawca interfejsu API płaci podatek od sprzedaży pobrany od subskrybentów lokalnym organom podatkowym w imieniu dewelopera. Dostawca interfejsu API przekazuje pozostałe przychody deweloperowi, a potem wystawia fakturę za prowizję.	Nie dotyczy	Tak
taxNexus	Kraj, w którym organizacja jest zarejestrowana na potrzeby podatkowe.	Nie dotyczy	Nie
taxRegNo	Numer rejestracji podatkowej organizacji lub numer VAT (jeśli został nadany). Ta właściwość jest opcjonalna, ponieważ numer rejestracyjny lub numer płatnika VAT nie jest wymagany we wszystkich krajach. Liczba wpisana w przypadku tego parametru jest wyświetlana na dole dokumentów rozliczeniowych.	Nie dotyczy	Nie
transactionRelayURL	Adres URL innego systemu, do którego można przekazywać transakcje, na przykład hurtowni danych.	Nie dotyczy	Nie
timezone	Identyfikator strefy czasowej organizacji, 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

Nadpisywanie ustawień profilu do zarabiania przez firmę lub dewelopera aplikacji

Zastąpić ustawienia profilu zarabiania firmy lub dewelopera aplikacji za pomocą interfejsu użytkownika lub interfejsu API, jak opisano w następujących sekcjach:

• Zarządzanie atrybutami niestandardowymi przez dewelopera aplikacji
• Zarządzanie firmami i deweloperami aplikacji
• Zarządzanie deweloperami aplikacji