Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info
Aşağıdaki bölümlerde kuruluş profili tanıtılmakta ve kullanıcı arayüzünü ve API'yi kullanarak kuruluş profilini nasıl yönetebileceğiniz açıklanmaktadır.
Kuruluş profili hakkında
Para kazanmayla ilgili ilk kurulum kapsamında 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.
Kuruluşunuzla ilgili temel bilgileri yapılandırın. Örneğin:
- Kuruluş adı, adresi ve faaliyet gösterdiği ülke
- Faturalandırma türünü anlama bölümünde açıklandığı gibi faturalandırma türü (ön ödemeli, faturalı veya her ikisi)
- Faturalandırma dönemi (eşit oranlı veya takvim ayı)
- Temel para birimi
- Kuruluşunuzun kullandığı vergi modeli
Kuruluş profilinizi, aşağıdaki bölümlerde açıklandığı gibi kullanıcı arayüzünü ve API'yi kullanarak yönetebilirsiniz.
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.
- Sol gezinme çubuğunda Yayınlama > Para kazanma > Kuruluş Profili'ni seçin.
Kuruluş Profili sayfası görüntülenir.
Şekilde de belirtildiği gibi, Kuruluş Profili sayfasında şunları yapabilirsiniz:
- Mevcut kuruluş profili ayarlarını görüntüleme
- Aşağıdakiler dahil olmak üzere kuruluş profili ayarlarını düzenleyin:
- Ad ve bilgiler
- Vergiler ve para birimi
- Hükümler ve koşulları yönetme bölümünde açıklanan 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:
http://ms-ip:9000
adresinde oturum açın. 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 dahil olmak üzere kuruluş profili ayarlarını düzenleyin:
- Ad ve bilgiler
- Vergiler ve para birimi
- Hükümler ve koşulları yönetme bölümünde açıklanan 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 gidin.
- Düzenle'yi tıklayın.
- Ad ve bilgiler bölümünde kuruluş adını ve faaliyet gösterdiği ülkeyi düzenleyin.
- Vergiler ve para birimi bölümünde aşağıdaki alanları düzenleyin:
Alan Açıklama Vergi Modeli Not: Yalnızca gelir paylaşımı ücret planları oluşturup faturalandırma dokümanı oluşturmak istiyorsanız geçerlidir.
Gerekli faturalandırma belgelerinin türünü tanımlayan, gelir paylaşımı ücret planları için vergi modeli.
Geçerli değerler şunlardır:
- Açık: API sağlayıcı, geliştiricinin açık bir aracısı olarak hareket eder. Son kullanıcıdan toplanan brüt gelir (satış vergileri dahil) geliştiriciye aktarılır. API sağlayıcının komisyonu, geliştiriciden komisyon faturası şeklinde alınır. API sağlayıcı, son kullanıcıdan alınan satış vergisini işlemez. Satış vergisini bildirme sorumluluğu geliştiriciye aittir.
- Açıklanmadı: API sağlayıcı, geliştiricinin açıklanmayan bir temsilcisi olarak hareket eder ve son kullanıcılardan alınan vergiyi düşerek yerel vergi makamlarına öder. Geliştirici, API sağlayıcıya geliştiriciye ait net gelir payı (satış vergileri ve API sağlayıcının komisyonu hariç) için fatura gönderir.
- Karma: API sağlayıcı, geliştiricinin açıklanmış bir aracısı olarak Ancak API sağlayıcı, abonelerinden toplanan satış vergisini geliştirici adına yerel vergi makamlarına öder. API sağlayıcı, kalan geliri geliştiriciye iletir ve ardından komisyon ücretlerini faturalandırır.
Para Birimi Kuruluşunuzun desteklediği para birimleri. Gelir paylaşımı, ücret listesi ve yalnızca ücret planları için ücret planınızda varsayılan para birimi kullanılır. Fiyat listesi veya yalnızca ücret planı oluştururken, desteklenen para birimlerinin listesinden seçim yaparak kullanılacak para birimini değiştirebilirsiniz. İsterseniz uygulama geliştiricilerin her para birimi için ön ödemeli hesap bakiyelerine ekleyebileceği minimum para ekleme tutarını ayarlayabilirsiniz.
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 ön ödemeli hesap bakiyelerine ekleyebilecekleri minimum tutarı, belirtilen para biriminde ayarlayın.
- Ekle'yi tıklayın.
- İlgili radyo düğmesini tıklayarak dilerseniz 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 getirin ve simgesini tıklayın.
- Kullanıcı arayüzünü kullanarak hükümler ve koşulları yönetme bölümünde açıklandığı şekilde hükümler ve koşulları yönetin.
- Kaydet'i tıklayın.
API'yi kullanarak kuruluş profilini yönetme
API'yi kullanarak kuruluş profilini aşağıdaki bölümlerde açıklandığı şekilde yönetin.
API'yi kullanarak kuruluş profilini görüntüleme
/mint/organizations/{org_name}
adresine 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ıta dair bir örnek verilmiştir. Gösterilen seçenekler hakkında daha fazla bilgi için API için kuruluş profili yapılandırma özellikleri başlıklı makaleyi inceleyin.
{ "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}
adresine PUT isteği göndererek kuruluş profilini düzenleyin. Kuruluş profilini düzenlerken yalnızca düzenlediğiniz ö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 USD olarak, 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 başlıklı makaleyi inceleyin.
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 faturalı faturalandırma türlerini yapılandırma
Geliştirici hesapları, aşağıdaki faturalandırma türlerini kullanacak şekilde yapılandırılabilir: ön ödemeli, faturalı veya her ikisi.
Ön ödemeli hesaplar sayesinde geliştiriciler, API'lerinizin kullanımı için önceden ödeme yapar. Fonlar, entegre bir ödeme sağlayıcısı aracılığıyla yönetilen geliştiricinin ön ödemeli bakiyesinden düşülür. Geliştiricinin, API'leri satın almaya yetecek kadar ön ödemeli bakiyesi olmalıdır.
Son ödemeli hesaplarda geliştiricilere ayın sonunda aylık olarak (fatura aracılığıyla) fatura gönderilir. Geliştirici, API ürünlerinin kullanımı için faturaya dahil edilen planlar tarafından belirlenen ödeme koşullarına göre ödeme yapar.
Kuruluşunuzun ön ödemeli ve faturalı faturalandırma türlerini yapılandırmak için supportedBillingType
mülkünü, geçerli faturalandırma türlerini belirtmek üzere aşağıdaki değerlerden birine ayarlayı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, Şirketleri ve uygulama geliştiricileri yönetme bölümünde açıklandığı gibi, API'yi kullanarak bir şirket veya uygulama geliştirici için faturalandırma türünü açıkça 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
mülkünü 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ına göre yapılı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, ülke ve bu adresin kuruluşun birincil adresi olup olmadığı bilgisini içerebilir). |
Yok | Hayır |
approveTrusted |
Bu işaret kullanılmaz. |
Yok | Hayır |
approveUntrusted |
Bu işaret kullanılmaz. |
Yok | Hayır |
billingCycle |
Faturalandırma dönemi. Değer aşağıdakilerden biri olabilir:
API'yi kullanarak faturalandırma döngüsünü yapılandırma başlıklı makaleyi inceleyin. |
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ığı "temel" veya muhasebe para birimi için ISO 4217 kodu (ör. ABD doları için USD). Gelir paylaşımı planları için: Planınız için belirtilen para birimi kullanılır. Ücret kartı (ücretlendirme modeli) planları için: Gelir paylaşımı planları için geçerli olan kurallar burada da geçerlidir. Ancak para birimi ayarını kuruluş tarafından desteklenen herhangi bir para birimine değiştirebilirsiniz. Yalnızca ücretli planlar için: Para birimi ayarını, kuruluş tarafından desteklenen herhangi bir para birimine 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ştirilirse API ürünleriniz için API Hizmetleri tarafından kaydedilen trafik ayrıntılarında düzenlemeler yapabilirsiniz. Değer aşağıdakilerden biri olabilir:
|
Yok | Hayır |
hasBroker |
Gelirin net gelire dayalı olup olmadığını belirten işaret. Değer aşağıdakilerden biri olabilir:
|
Yok | Hayır |
hasSelfBilling |
Para kazanma özelliğini, gelir paylaşımı ekstresi yerine kendi kendine faturalandırma faturası oluşturmaya yönlendiren işaret. Self servis fatura, uygulama geliştiriciye ödenmesi gereken tutarı ayrıntılarıyla gösteren mali bir belgedir. Uygulama geliştirici adına API sağlayıcıya fatura işlevi görür. Değer aşağıdakilerden biri olabilir:
|
Yok | Hayır |
hasSeparateInvoiceForProduct |
Her API ürünü için ayrı bir fatura oluşturulup oluşturulmayacağı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 dokümanları oluşturulurken bir netleştirme beyanının oluşturulup oluşturulmayacağını belirten işaret. 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 talimatı notu. |
Yok | Hayır |
nettingStmtPerCurrency |
Kullanılan her para birimi için ayrı bir netleştirme beyanının oluşturulup oluşturulmayacağını belirten işaret. Değer aşağıdakilerden 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 |
Self servis faturalar etkinse exchange kuruluşları için etkinleştirilip etkinleştirilmediğini belirtir. Değer aşağıdakilerden biri olabilir:
|
Yok | Hayır |
selfBillingForAllDev |
Self servis faturalar etkinse bu özelliğin tüm uygulama geliştiricileri için etkinleştirilip etkinleştirilmediğini belirtir. Varsayılan olarak, kendi kendine faturalandırma faturaları yalnızca API sağlayıcıyla sözleşme imzalamış uygulama geliştiricileri için oluşturulur. Değer aşağıdakilerden biri olabilir:
|
yanlış | Hayır |
separateInvoiceForFees |
Ücretler için ayrı bir faturanın yayınlanıp yayınlanmadığını belirten işaret. Değer aşağıdakilerden biri olabilir:
|
yanlış | 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 aşağıdakilerden biri olabilir:
API'yi kullanarak ön ödemeli ve faturalı faturalandırma türlerini yapılandırma başlıklı makaleyi inceleyin. |
PREPAID | Evet |
taxModel |
Not: Yalnızca gelir paylaşımı ücret planları oluşturup faturalandırma dokümanı oluşturmak istiyorsanız geçerlidir. Gerekli faturalandırma belgelerinin türünü tanımlayan, gelir paylaşımı ücret planları için vergi modeli. Geçerli değerler şunlardır:
|
Yok | Evet |
taxNexus |
Kuruluşun vergi mükellefi olduğu ülke. |
Yok | Hayır |
taxRegNo |
Kuruluşun vergi tescil numarası veya varsa Katma Değer Vergisi (KDV) tescil numarası. Vergi tescil numarası veya KDV tescil numarası tüm ülkelerde geçerli olmadığından bu özellik isteğe bağlıdır. Bu parametre için girdiğiniz sayı, faturalandırma belgelerinin alt kısmında gösterilir. |
Yok | Hayır |
transactionRelayURL |
İşlemlerin aktarılabileceği başka bir sistemin URL'si (ör. veri ambarı). |
Yok | Hayır |
timezone |
Kuruluşun operasyonları için saat dilimi tanımlayıcısı (ör. Amerika/New_York veya Avrupa/Paris). UTC, EST (Doğu Standart |
Yok | Evet |
Bir şirket veya uygulama geliştirici için para kazanma profili ayarlarını geçersiz kılma
Aşağıdaki bölümlerde açıklandığı gibi, kullanıcı arayüzünü veya API'yi kullanarak bir şirket veya uygulama geliştirici için para kazanma profili ayarlarını geçersiz kılabilirsiniz: