Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Aşağıdaki bölümlerde kuruluş profili tanıtılmakta, kullanıcı arayüzü ve API'yi kullanarak profili nasıl yönetebileceğiniz açıklanmaktadır.
Kuruluş profili hakkında
Para kazanma özelliğinin ilk kurulumunun bir parçası olarak Apigee Edge yapılandırma ekibi, kuruluş profilinizi oluşturur.
Kuruluşunuzla ilgili bilgileri 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 bölümünde açıklandığı üzere faturalandırma türü (ön ödemeli, sonradan ödemeli veya her ikisi de)
- Faturalandırma döngüsü (eşit olarak dağıtılmış veya takvim ayı)
- Temel para birimi
- Kuruluşunuzda kullanılan vergi modeli
Kuruluş profilinizi aşağıdaki bölümlerde açıklandığı şekilde kullanıcı arayüzü ve API'yi kullanarak yönetebilirsiniz.
Kuruluş Profili sayfasını keşfetme
Kuruluş Profili sayfasına aşağıda açıklanan şekilde 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.
- Sol gezinme çubuğunda Yayınla > Para Kazanma > Kuruluş Profili'ni seçin.
Kuruluş Profili sayfası görüntülenir.
Şekilde vurgulandığı gibi, Kuruluş Profili sayfasında ş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 bilgi
- Vergiler ve para birimi
- Şartlar ve koşulları yönetme bölümünde açıklanan şartlar ve koşullar
Klasik Edge (Private Cloud)
Klasik Edge kullanıcı arayüzünü kullanarak Kuruluş Profili sayfasına erişmek için:
http://ms-ip:9000
üzerinde oturum açın. Burada ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.- Üst gezinme çubuğunda Yönetici > Kuruluş Profili'ni seçin.
Kuruluş Profili sayfası görüntülenir.
Kuruluş Profili sayfasında ş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 bilgi
- Vergiler ve para birimi
- Şartlar ve koşulları yönetme bölümünde açıklanan şartlar 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 ülkesini 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şturmak istiyorsanız geçerlidir.
Gelir paylaşımı ücret planları için gerekli faturalandırma belgelerinin türünü tanımlayan vergi modeli.
Geçerli değerler şunları içerir:
- Açıklandı: API sağlayıcı, geliştiricinin açıklanan aracısı olarak hareket eder. Son kullanıcıdan toplanan brüt gelir (satış vergileri dahil) geliştiriciye iletilir. API sağlayıcısının komisyonu, geliştiriciden komisyon faturası şeklinde tahsil edilir. API sağlayıcısı, son kullanıcıdan toplanan satış vergisini işlemez ve satış vergisini bildirmek geliştiricinin sorumluluğundadır.
- Açıklanmamış: API sağlayıcı, geliştiricinin açık olmayan temsilcisi olarak hareket eder ve son kullanıcılardan toplanan vergiyi düşerek yerel vergi kurumlarına öder. Geliştirici, geliştiriciye ödenecek net gelir paylaşımı için (daha düşük satış vergileri ve API sağlayıcısının komisyonu) API sağlayıcısına fatura keser.
- Karma: API sağlayıcısı, geliştiricinin açıklanan aracısı olarak hareket eder. Bununla birlikte API sağlayıcısı, abonelerinden toplanan satış vergisini geliştirici adına yerel vergi kurumlarına öder. API sağlayıcısı, kalan geliri geliştiriciye iletir ve ardından komisyon ücretlerini faturalandırır.
Currency Kuruluşunuzun desteklediği para birimleri. Gelir paylaşımı, ücret listesi ve yalnızca ücret planları söz konusu olduğunda, ü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 kullanılacak para birimini değiştirebilirsiniz. İ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, uygulama geliştiricilerin ön ödemeli hesap bakiyelerine ekleyebileceği minimum tutarı Minimum para ekleme alanında belirtilen para biriminde ayarlayabilirsiniz.
- Ekle'yi tıklayın.
- İsterseniz ilgili radyo düğmesini tıklayarak varsayılan para birimi olarak ayarlayın.
- Başka para birimleri eklemek için adımları tekrarlayın.
Bir para birimini silmek için imlecinizi silmek istediğiniz para biriminin üzerine getirip simgesini tıklayın.
- Hükümler ve koşulları, Kullanıcı arayüzünü kullanarak hükümler ve koşulları yönetme bölümünde açıklandığı şekilde yönetin.
- Kaydet'i tıklayın.
API'yi kullanarak kuruluş profilini yönetme
Kuruluş profilini, aşağıdaki bölümlerde açıklandığı şekilde API'yi kullanarak yönetin.
API'yi kullanarak kuruluş profilini görüntüleme
/mint/organizations/{org_name}
için GET isteği göndererek kuruluş profilinizi görüntüleyin. Ö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. Gösterilen seçenekler hakkında 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
/mint/organizations/{org_name}
için PUT isteği göndererek kuruluş profilini düzenleyin. Kuruluş profilini düzenlerken yalnızca düzenlemekte olduğunuz özellikleri değil, tüm kuruluş profili özelliklerini belirtmeniz gerekir.
Kuruluşun varsayılan para birimini düzenlemek için currency
değerini, varsayılan olarak ayarlamak istediğiniz desteklenen para biriminin ISO 4217 para birimi koduna ayarlayın.
Örneğin, aşağıdaki API çağrısı currency
değerini ABD doları, vergi modeli ayarını ise HYBRID
olarak günceller (güncellenen alanlar örnekte vurgulanmıştır). Gösterilen seçenekler hakkında daha fazla bilgi için API için kuruluş profili yapılandırma özellikleri bölümüne 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. Tutar, geliştiricinin entegre bir ödeme sağlayıcı tarafından yönetilen ön ödeme bakiyesinden düşülür. Geliştiricinin, API'leri satın almak için yeterli ön ödeme bakiyesine sahip olması gerekir.
Faturalı hesaplarda, geliştiriciler ay sonunda aylık olarak (faturayla) faturalandırılır. Geliştirici, faturada yer alan planlara göre belirlenen ödeme şartlarına göre API ürünlerinin kullanımı için ödeme yapar.
Kuruluşunuzun ön ödemeli ve sonradan ödemeli faturalandırma türlerini yapılandırmak için supportedBillingType
özelliğini şu değerlerden birine ayarlayarak hangi faturalandırma türlerinin geçerli olduğunu belirtin: 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, Şirketleri ve uygulama geliştiricilerini yönetme bölümünde açıklandığı gibi, API'yi kullanan bir şirket veya uygulama geliştirici için faturalandırma türünü açık bir şekilde ayarlayabilirsiniz.
Ö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, bir 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. Bu adres, açık adres, şehir, eyalet, posta kodu ve ülke bilgisini içerebilir ve kuruluşun birincil adresi olup olmadığını belirtir. |
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 göz atın. |
Yok | Evet |
country |
Kuruluşun faaliyet gösterdiği ülke için ISO 3166-2 kodu (ör. Brezilya için BR). |
Yok | Evet |
currency |
Kuruluşun kullandığı "taban" veya muhasebe para birimi için ISO 4217 kodu (ör. ABD doları için USD). Gelir paylaşımı planları için: Planınızda belirtilen para birimi 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ı, kuruluş tarafından desteklenen herhangi bir para birimi olarak değiştirebilirsiniz. Yalnızca ücretli planlar için: Para birimi ayarını kuruluş tarafından desteklenen herhangi bir para birimi ile değiştirebilirsiniz. |
Yok | Evet |
description |
Kuruluşun kısa açıklaması. |
Yok | Hayır |
hasBillingAdjustment |
Ayarlamaların etkin olup olmadığını belirten işaret. Etkinleştirildiğinde, API ürünleriniz için API Hizmetleri tarafından kaydedilen trafik ayrıntılarında ayarlamalar yapabilirsiniz. Değer, aşağıdakilerden biri olabilir:
|
Yok | Hayır |
hasBroker |
Gelirin nete dayalı olup olmadığını belirten işaret. Değer, aşağıdakilerden biri olabilir:
|
Yok | Hayır |
hasSelfBilling |
Gelir paylaşımı beyanı yerine kendi kendine faturalandırma faturası oluşturmaya para kazanmayı yönlendiren işaret. Otomatik faturalandırma faturası, uygulama geliştiricisine ödenecek tutarı ayrıntılı olarak açıklayan bir finansal belgedir. Uygulama geliştiricisi adına API Sağlayıcısı'na fatura görevi görür. Değer şunlardan biri olabilir:
|
Yok | Hayır |
hasSeparateInvoiceForProduct |
Her API ürünü için ayrı bir fatura oluşturulup oluşturulmadığını belirten işaret. Değer, aşağıdakilerden biri olabilir:
|
Yok | Hayır |
id |
Kuruluşun kimliği. |
Yok | Hayır |
issueNettingStmt |
Faturalandırma belgeleri oluşturulurken ağ bildirimi oluşturulup oluşturulmayacağını belirten işaret. Değer şunlardan biri olabilir:
|
Yok | Hayır |
logoUrl |
Kuruluş logosunun URL'si. |
Yok | Hayır |
name |
Kuruluşun adı. |
Yok | Evet |
netPaymentAdviceNote |
Net ödeme tavsiye notu. |
Yok | Hayır |
nettingStmtPerCurrency |
Kullanılan her para birimi için ayrı bir ağ bildiriminin oluşturulup oluşturulmadığını belirten işaret. Değer şunlardan biri olabilir:
|
Yok | Hayır |
regNo |
Kuruluşun tescil numarası. Bu mülk için girdiğiniz numara, faturalandırma belgelerinin alt kısmında gösterilir. |
Yok | Hayır |
selfBillingAsExchOrg |
Otomatik faturalandırma faturaları etkinse exchange kuruluşları için etkin olup olmadığını belirtir. Değer şunlardan biri olabilir:
|
Yok | Hayır |
selfBillingForAllDev |
Otomatik faturalandırma faturaları etkinse bunun tüm uygulama geliştiriciler için etkin olup olmadığını belirtir. Otomatik faturalandırma faturaları, varsayılan olarak yalnızca API sağlayıcısıyla sözleşme imzalamış uygulama geliştiricileri için oluşturulur. Değer şunlardan biri olabilir:
|
false | Hayır |
separateInvoiceForFees |
Ücretler için ayrı bir fatura yayınlanıp yayınlanmadığını belirten işaret. Değer şunlardan biri olabilir:
|
false | Evet |
status |
Kuruluşun durumu. Geçerli değerler şunları içerir:
|
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ı makaleyi inceleyin. |
ÖN ÖDENDİ | Evet |
taxModel |
Not: Yalnızca gelir paylaşımı ücret planları ayarladıysanız ve faturalandırma belgeleri oluşturmak istiyorsanız geçerlidir. Gelir paylaşımı ücret planları için gerekli faturalandırma belgelerinin türünü tanımlayan vergi modeli. Geçerli değerler şunları içerir:
|
Yok | Evet |
taxNexus |
Kuruluşun vergi işlemleri için kayıtlı olduğu ülke. |
Yok | Hayır |
taxRegNo |
Varsa kuruluşun vergi sicil numarası veya Katma Değer Vergisi (KDV) sicil numarası. Vergi sicil numarası veya KDV kayıt numarası tüm ülkelerde geçerli olmadığından bu özellik isteğe bağlıdır. Bu parametre için girdiğiniz numara, faturalandırma belgelerinin alt kısmında gösterilir. |
Yok | Hayır |
transactionRelayURL |
İşlemlerin iletilebileceği başka bir sistemin (ör. veri ambarı) URL'si. |
Yok | Hayır |
timezone |
Kuruluşun işlemleri için saat dilimi tanımlayıcısı (ör. America/New_York veya Europe/Paris). UTC, EST (Doğu Standart Saati) veya CET (Orta Avrupa Saati) gibi saat dilimi kısaltmaları da desteklenir. |
Yok | Evet |
Bir şirketin veya uygulama geliştiricisinin para kazanma profili ayarlarını geçersiz kılma
Kullanıcı arayüzünü veya API'yi kullanarak, bir şirketin veya uygulama geliştiricisinin para kazanma profili ayarlarını aşağıdaki bölümlerde açıklandığı şekilde geçersiz kılın: