Apigee Edge belgelerini görüntülüyorsunuz.
.
Git:
Apigee X belgeleri. bilgi
Aşağıdaki bölümlerde kuruluş profili tanıtılmakta ve kullanıcı arayüzü ve API'yi kullanarak bu profili nasıl yönetebileceğiniz açıklanmaktadır.
Kuruluş profili hakkında
Apigee Edge yapılandırma ekibi, ilk para kazanma kurulumunun bir parçası olarak kuruluş profilinizi oluşturur.
Kuruluşunuzla ilgili bilgileri uygun şekilde eklemek veya güncellemek için kuruluş profilini düzenlemeniz gerekir. Örneğin, faturalandırma türünü, para birimi ayarlarını veya vergi modelini güncellemeniz gerekebilir.
Aşağıdakiler dahil olmak üzere kuruluşunuzla ilgili temel bilgileri yapılandırın:
- Kuruluş adı, adresi ve faaliyet ülkesi
- Faturalandırma türünü anlama başlıklı makalede açıklandığı gibi faturalandırma türü (ön ödemeli, sonradan ödemeli veya her ikisi)
- Faturalandırma döngüsü (eşit olarak bölünmüş veya takvim ayı)
- Temel para birimi
- Kuruluşunuzun kullandığı vergi modeli
Kuruluş profilinizi, aşağıda açıklandığı gibi kullanıcı arayüzü ve API'yi kullanarak yönetebilirsiniz. bu bölümde bulabilirsiniz.
Kuruluş Profili sayfasını keşfetme
Aşağıda açıklandığı şekilde Kuruluş Profili sayfasına erişin.
Edge
Edge kullanıcı arayüzünü kullanarak Kuruluş Profili sayfasına erişmek için:
- apigee.com/edge adresinde oturum açın.
- Yayınla > Para kazanma > Organization Profile (Kuruluş Profili) seçeneğini tıklayın.
Kuruluş Profili sayfası görüntülenir.
Şekilde vurgulandığı gibi, Kuruluş Profili sayfasını kullanarak şunları yapabilirsiniz:
- Mevcut kuruluş profili ayarlarını görüntüleme
- Aşağıdakiler de dahil olmak üzere kuruluş profili ayarlarını düzenleyin:
- Ad ve bilgiler
- Vergiler ve para birimi
- Hükümler ve koşulları yönetme konusunda açıklandığı üzere Hükümler ve Koşullar
Klasik Edge (Private Cloud)
Klasik Edge kullanıcı arayüzünü kullanarak Kuruluş Profili sayfasına erişmek için:
- ms-ip olan
http://ms-ip:9000
uygulamasında oturum açın Yönetim Sunucusu düğümünün IP adresi veya DNS adı. - Yönetici > Organization Profile (Kuruluş Profili) seçeneğini tıklayın.
Kuruluş Profili sayfası görüntülenir.
Kuruluş Profili sayfası şu işlemleri yapmanıza olanak tanır:
- Mevcut kuruluş profili ayarlarını görüntüleme
- Aşağıdakiler de dahil olmak üzere kuruluş profili ayarlarını düzenleyin:
- Ad ve bilgiler
- Vergiler ve para birimi
- Hükümler ve koşulları yönetme konusunda açıklandığı üzere Hükümler ve Koşullar
Kullanıcı arayüzünü kullanarak kuruluş profilini düzenleme
Kullanıcı arayüzünü kullanarak kuruluş profilini düzenlemek için:
- Kuruluş Profili sayfasına erişin.
- Düzenle'yi tıklayın.
- Ad ve bilgiler bölümünde, kuruluş adını ve faaliyet gösterilen ülkeyi düzenleyin.
- Vergiler ve para birimi altında, aşağıdaki alanları düzenleyin:
Alan Açıklama Vergi Modeli Not: Yalnızca gelir paylaşımı ücret planları ayarladıysanız ve faturalandırma belgeleri oluşturun.
Gelir paylaşımı oranı planları için, gerekli faturalandırma belgelerinin türünü tanımlayan vergi modeli.
Geçerli değerler şunlardır:
- Açıklandı: API sağlayıcısı, geliştiriciyim. Son kullanıcıdan toplanan brüt gelir (satış vergileri dahil) geliştiriciye de iletildi. API sağlayıcının komisyonu, bir geliştiriciye dönüşür. API sağlayıcısı, son kullanıcıdan tahsil edilen satış vergisine tabidir ve bu, geliştiricinin sorumluluğundadır. gerekir.
- Açıklanmamış: API sağlayıcısı, açıklanmayan bir aracısıdır: ve son kullanıcılardan tahsil edilen vergiyi düşerek yerel vergi kurumlarına aittir. Geliştirici, API sağlayıcıya net gelir için fatura düzenler (daha düşük satış vergileri ve API sağlayıcının komisyonu) yardımcı olabilir.
- Karma: API sağlayıcısı, geliştiriciyim. Ancak API sağlayıcısı, kendisinden alınan satış vergisini Geliştirici adına yerel vergi kurumlarına abone olanlar. API kalan geliri geliştiriciye gönderir ve ardından bu gelirin faturasını komisyon ücreti alınır.
Para Birimi Kuruluşunuzun desteklediği para birimleri. Gelir paylaşımı, ücret listesi ve yalnızca ücret planları için ücret planınız için varsayılan para birimi kullanılır. Ücret listesi veya yalnızca ücret planı oluşturduğunuzda, desteklenen para birimleri listesinden seçim yaparak kullanabilirsiniz. İsteğe bağlı olarak, uygulama geliştiricilerin her para birimi için ön ödemeli hesap bakiyelerine ekleyebileceği minimum para ekleme tutarını belirleyebilirsiniz.
Para birimi eklemek için:
- Para birimi ekle'yi tıklayın.
- Para birimi alanındaki açılır menüden bir para birimi seçin.
- İsteğe bağlı olarak, Minimum para ekleme alanında, uygulama geliştiricilerin belirtilen para biriminde ön ödemeli hesap bakiyelerine ekleyebileceği minimum tutarı ayarlayabilirsiniz.
- Ekle'yi tıklayın.
- İsterseniz, ilişkili radyo düğmesini tıklayarak varsayılan para birimini ayarlayın.
- Başka para birimleri eklemek için bu adımları tekrarlayın.
Bir para birimini silmek için imlecinizi silmek istediğiniz para biriminin üzerine getirin ve simgesini tıklayın.
- Hükümler ve koşulları, Kullanıcı arayüzünü kullanarak hüküm ve koşulları yönetme konusunda açıklandığı şekilde yönetin.
- Kaydet'i tıklayın.
API'yi kullanarak kuruluş profilini yönetme
Kuruluş profilini API'yi kullanarak aşağıdaki bölümlerde açıklandığı şekilde yönetin.
API'yi kullanarak kuruluş profilini görüntüleme
Şu kullanıcıya GET isteği göndererek kuruluş profilinizi görüntüleyin:
/mint/organizations/{org_name}
Örneğin:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Accept: application/json" \ -u email:password
Aşağıda yanıtın bir örneği verilmiştir. Mevcut seçeneklerle ilgili daha fazla bilgi için API için kuruluş profili yapılandırma özellikleri bölümüne bakın.
{ "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" }
API'yi kullanarak kuruluş profilini düzenleme
Şuna bir PUT isteği göndererek kuruluş profilini düzenleyin:
/mint/organizations/{org_name}
Kuruluş profilini düzenlerken tüm
kuruluş profili özelliklerine de erişebilirsiniz.
Kuruluşun varsayılan para birimini düzenlemek için currency
değerini şu şekilde ayarlayın:
ISO 4217 para birimi
varsayılan olarak ayarlamak istediğiniz desteklenen para biriminin kodunu öğrenebilirsiniz.
Örneğin, aşağıdaki API çağrısı currency
değerini USD olarak ve vergi modelini günceller
değerini HYBRID
olarak ayarlayın (güncellenen alanlar örnekte vurgulanmıştır). Daha fazla
daha fazla bilgi için bkz. Kuruluş profili yapılandırması
özelliklerine bakın.
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
API'yi kullanarak ön ödemeli ve sonradan ödemeli faturalandırma türlerini yapılandırma
Geliştirici hesapları şu faturalandırma türlerini kullanacak şekilde yapılandırılabilir: ön ödemeli, sonradan ödemeli veya her ikisi.
Ön ödemeli hesaplarda geliştiriciler, API'lerinizin kullanımı için önceden ödeme yapar. Para, geliştiricinin entegre bir ödeme sağlayıcı aracılığıyla yönetilen ön ödeme bakiyesinden düşülür. Geliştiricinin, API'leri satın almaya yetecek kadar bir ön ödeme bakiyesi bulundurması gerekir.
Faturalı hesaplarda geliştiriciler, ay sonunda aylık olarak (fatura yoluyla) faturalandırılır. Geliştirici, API ürünlerinin kullanımı için ödeme yaparken faturada yer alan planlara göre belirlenen ödeme şartlarına göre ödeme yapar.
Kuruluşunuz için ön ödemeli ve sonradan ödemeli faturalandırma türlerini yapılandırmak üzere supportedBillingType
özelliğini
geçerli faturalandırma türlerini belirtmek için şu değerleri kullanın: PREPAID
, POSTPAID
veya BOTH
. Değeri BOTH
olarak ayarlarsanız
bir uygulama geliştirici veya şirket eklediğinizde varsayılan değer PREPAID
olur. Bu durumda, API'yi kullanan bir şirket veya uygulama geliştirici için faturalandırma türünü aşağıdaki şekilde açıkça ayarlayabilirsiniz:
Şirketleri ve uygulama geliştiricilerini yönetme.
Örneğin:
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
API'yi kullanarak faturalandırma döngüsünü yapılandırma
Kuruluşunuzun faturalandırma döngüsünü yapılandırmak için billingCycle
özelliğini aşağıdaki değerlerden birine ayarlayın:
PRORATED
: Faturalandırma, API ürününün bir takvim ayında kullanıldığı gün sayısını temel alır.CALENDAR_MONTH
: Faturalandırma aylık olarak yapılır.
Örneğin:
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
API için kuruluş profili yapılandırma özellikleri
Kuruluş profili, API'yi kullanarak aşağıdaki yapılandırma özelliklerini ayarlamanıza olanak tanır.
Ad | Açıklama | Varsayılan | Zorunlu mu? |
---|---|---|---|
address |
Kuruluşun adresi (açık adres, şehir, eyalet, posta kodu gibi bilgiler) kod, ülke ve bunun müşterinin birincil adresi olup olmadığını belirten kurum içinde tutmaktır. |
Yok | Hayır |
approveTrusted |
Bu işaret kullanılmıyor. |
Yok | Hayır |
approveUntrusted |
Bu işaret kullanılmıyor. |
Yok | Hayır |
billingCycle |
Faturalandırma dönemi dönemi. Değer şunlardan biri olabilir:
API'yi kullanarak faturalandırma döngüsünü yapılandırma bölümüne bakın. |
Yok | Evet |
country |
Ülke için ISO 3166-2 kodu (ör. Brezilya için BR) |
Yok | Evet |
currency |
"Taban" için ISO 4217 kodu veya kuruluşun kullandığı muhasebe para birimi (örneğin, ABD için ABD doları dolar). Gelir paylaşımı planları için: Belirtilen para birimi, planınızda kullanılır. Ücret listesi (ödeme modeli) planları için: Aynı durum, gelir paylaşımı planları için de geçerlidir. Ancak, para birimi ayarını kurum içinde tutmaktır. Yalnızca ücretli planlar için: Para birimi ayarını kurum içinde tutmaktır. |
Yok | Evet |
description |
Kurumun kısa açıklaması. |
Yok | Hayır |
hasBillingAdjustment |
Ayarlamaların etkin olup olmadığını belirten işaret. Bu özellik etkinleştirilirse API ürünleriniz için API Hizmetleri tarafından kaydedilen trafik ayrıntılarında yapılan düzenlemeler değeri şunlardan biri olabilir:
|
Yok | Hayır |
hasBroker |
Gelirin net temelli olup olmadığını belirten işaret. Değer şunlardan biri olabilir: şu:
|
Yok | Hayır |
hasSelfBilling |
Para kazanmayı, gelir yerine kendi kendine faturalandırma şeklinde fatura oluşturmaya yönlendiren işaret beyanda bulunun. Kendi kendine faturalandırma faturası, ödeme tutarının ayrıntılı olarak gösterildiği finansal bir belgedir uygulama geliştiricisinden kaynaklanır. adına API Sağlayıcısına fatura uygulama geliştiriciyim. Değer aşağıdakilerden biri olabilir:
|
Yok | Hayır |
hasSeparateInvoiceForProduct |
Her API ürünü için ayrı fatura oluşturulup oluşturulmadığını belirten işaret. İlgili içeriği oluşturmak için kullanılan değeri şunlardan biri olabilir:
|
Yok | Hayır |
id |
Kuruluşun kimliği. |
Yok | Hayır |
issueNettingStmt |
Faturalandırma oluşturulurken ağ özeti oluşturulup oluşturulmadığını belirten işaret yardımcı olur. Değer aşağıdakilerden biri olabilir:
|
Yok | Hayır |
logoUrl |
Kuruluşun logosunun URL'si. |
Yok | Hayır |
name |
Kuruluşun adı. |
Yok | Evet |
netPaymentAdviceNote |
Net ödeme tavsiyesi notu. |
Yok | Hayır |
nettingStmtPerCurrency |
Her biri için ayrı bir ağ ifadesi oluşturulup oluşturulmadığını belirten işaret para birimi. Değer aşağıdakilerden biri olabilir:
|
Yok | Hayır |
regNo |
Kuruluşun tescil numarası. Bu mülk için girdiğiniz sayı faturalandırma dokümanlarının alt kısmında görebilirsiniz. |
Yok | Hayır |
selfBillingAsExchOrg |
Kendi kendine faturalandırma etkinleştirilmişse bu özelliğin exchange için etkin olup olmadığını belirtir kuruluşlar. Değer aşağıdakilerden biri olabilir:
|
Yok | Hayır |
selfBillingForAllDev |
Kendi kendine faturalandırma etkinleştirilmişse bu özelliğin, tüm hesapların uygulama geliştiricilere aittir. Varsayılan olarak, self servis faturalandırma faturaları yalnızca API sağlayıcısıyla sözleşme imzalamıştır. Değer aşağıdakilerden biri olabilir:
|
false | Hayır |
separateInvoiceForFees |
Ücretler için ayrı bir fatura yayınlanıp yayınlanmadığını belirten işaret. Değer şöyle olabilir: şunlardan birini yapın:
|
false | Evet |
status |
Kuruluşun durumu. Geçerli değerler şunlardır:
|
Yok | Hayır |
supportedBillingType |
Faturalandırma için kullanılan geliştirici ödeme modeli. Değer şunlardan biri olabilir:
API'yi kullanarak ön ödemeli ve sonradan ödemeli faturalandırma türlerini yapılandırma başlıklı makaleye bakın. |
ÖN ÖDEMELİ | Evet |
taxModel |
Not: Yalnızca gelir paylaşımı ücret planları ayarladıysanız ve faturalandırma belgeleri oluşturun. Gelir paylaşımı oranı planları için, gerekli faturalandırma belgelerinin türünü tanımlayan vergi modeli. Geçerli değerler şunlardır:
|
Yok | Evet |
taxNexus |
Kuruluşun vergi işlemlerinde kayıtlı olduğu ülke. |
Yok | Hayır |
taxRegNo |
Kuruluşun vergi sicil numarası veya Katma Değer Vergisi (KDV) tescili numarası (varsa) gösterilir. Bu özellik isteğe bağlıdır çünkü vergi sicil numarası veya KDV tescil numarası tüm ülkelerde geçerli değildir. Bunun için girdiğiniz sayı parametresi, faturalandırma dokümanlarının en altında gösterilir. |
Yok | Hayır |
transactionRelayURL |
İşlemlerin iletilebileceği başka bir sistemin (ör. veri) URL'si depolamış olursunuz. |
Yok | Hayır |
timezone |
Kuruluşun işlemleri için saat dilimi tanımlayıcısı. Örneğin, Amerika/New_York veya Avrupa/Paris. UTC, EST (Doğu) gibi saat dilimi kısaltmaları Standart Saat) veya CET (Orta Avrupa Saati) de desteklenir. |
Yok | Evet |
Bir şirket veya uygulama geliştirici için para kazanma profili ayarlarını geçersiz kılma
Kullanıcı arayüzünü veya API'yi kullanarak bir şirket ya da uygulama geliştirici için para kazanma profili ayarlarını aşağıdaki bölümlerde açıklandığı şekilde geçersiz kılın: