Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
As seções a seguir apresentam o perfil da organização e descrevem como ele pode ser gerenciado usando a interface e a API.
Sobre o perfil da organização
Como parte da configuração inicial da monetização, a equipe de configuração do Apigee Edge define o perfil da sua organização.
Você precisa editar o perfil da organização para adicionar ou atualizar informações sobre ela, conforme necessário. Por exemplo, talvez seja necessário atualizar o tipo de faturamento, as configurações de moeda ou o modelo fiscal.
Configure informações básicas sobre sua organização, incluindo:
- Nome, endereço e país de operação da organização
- Tipo de faturamento (pré-pago, pós-pago ou ambos), conforme descrito em Entender o tipo de faturamento
- Ciclo de faturamento (proporcionalmente ou por mês)
- Moeda base
- Modelo fiscal usado pela sua organização
É possível gerenciar o perfil da organização usando a interface e a API, conforme descrito nas seções a seguir.
Conheça a página do perfil da organização
Acesse a página "Perfil da organização", conforme descrito abaixo.
Edge
Para acessar a página "Perfil da organização" usando a interface do usuário do Edge:
- Faça login em apigee.com/edge.
- Selecione Publicar > Monetização > Perfil da organização na barra de navegação à esquerda.
A página "Perfil da organização" é exibida.
Como destacado na figura, a página Perfil da organização permite que você:
- Conferir as configurações atuais do perfil da organização
- Edite as configurações do perfil da organização, incluindo:
- Nome e informações
- Tributos e moeda
- Termos e Condições, conforme descrito em Como gerenciar os Termos e Condições
Borda clássica (nuvem privada)
Para acessar a página do perfil da organização usando a interface clássica do Edge:
- Faça login em
http://ms-ip:9000
, em que ms-ip é o endereço IP ou o nome DNS do nó do servidor de gerenciamento. - Selecione Administrador > Perfil da organização na barra de navegação superior.
A página "Perfil da organização" é exibida.
Na página "Perfil da organização", você pode:
- Conferir as configurações atuais do perfil da organização
- Edite as configurações do perfil da organização, incluindo:
- Nome e informações
- Tributos e moeda
- Termos e Condições, conforme descrito em Como gerenciar os Termos e Condições
Editar o perfil da organização usando a interface
Para editar o perfil da organização usando a interface:
- Acesse a página "Perfil da organização".
- Clique em Editar.
- Em Nome e informações, edite o nome da organização e o país de operação.
- Em Tributos e moeda, edite os seguintes campos:
Campo Descrição Modelo fiscal Observação:aplicável somente se você configurar planos de tarifas de participação na receita e quiser gerar documentos de faturamento.
Modelo fiscal para planos de tarifas de participação na receita que identifica o tipo de documento de faturamento necessário.
Valores válidos:
- Divulgação: o provedor de API atua como um agente divulgado do desenvolvedor. A receita bruta (incluindo os tributos sobre vendas) coletada do usuário final é repassada ao desenvolvedor. A comissão do provedor da API é coletada do desenvolvedor na forma de uma fatura de comissão. O provedor de API não processa o tributo sobre vendas coletado do usuário final. É responsabilidade do desenvolvedor declarar o tributo sobre vendas.
- Não divulgado: o provedor da API atua como um agente não divulgado do desenvolvedor e deduz o tributo coletado dos usuários finais e o paga às autoridades fiscais locais. O desenvolvedor fatura o provedor da API com a participação líquida na receita devida ao desenvolvedor (menos tributos sobre vendas e a comissão do provedor da API).
- Híbrido: o provedor de API atua como um agente divulgado do desenvolvedor. No entanto, o provedor da API paga o tributo sobre vendas coletado dos assinantes às autoridades fiscais locais em nome do desenvolvedor. O provedor de API repassa a receita restante para o desenvolvedor e, em seguida, fatura as cobranças de comissão.
Moeda Moedas aceitas pela sua organização. A moeda padrão é usada para participação na receita, tabela de preços e planos somente para tarifas. Ao criar uma tabela de preços ou um plano somente de tarifas, é possível alterar a moeda a ser usada selecionando uma das moedas aceitas na lista. Outra opção é definir o valor mínimo de recarga que os desenvolvedores de apps podem adicionar ao saldo pré-pago da conta para cada moeda.
Para adicionar uma moeda:
- Clique em Adicionar moeda.
- Selecione uma moeda no menu suspenso do campo Moeda.
- Como opção, defina o valor mínimo que os desenvolvedores de apps podem adicionar ao saldo da conta pré-paga na moeda especificada no campo Recarga mínima.
- Clique em Adicionar.
- Defina como a moeda padrão, se quiser, clicando no botão de opção associado.
- Repita as etapas para adicionar mais moedas.
Para excluir uma moeda, posicione o cursor sobre a moeda que você deseja excluir e clique em .
- Gerencie os Termos e Condições conforme descrito em Como gerenciar Termos e Condições usando a IU.
- Clique em Salvar.
Gerenciar o perfil da organização usando a API
Gerencie o perfil da organização usando a API, conforme descrito nas seções a seguir.
Acessar o perfil da organização usando a API
Confira o perfil da sua organização enviando uma solicitação GET para
/mint/organizations/{org_name}
. Exemplo:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Accept: application/json" \ -u email:password
Veja a seguir um exemplo de resposta. Para mais informações sobre as opções mostradas, consulte Propriedades de configuração do perfil da organização para a 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" }
Editar o perfil da organização usando a API
Edite o perfil da organização emitindo uma solicitação PUT para
/mint/organizations/{org_name}
. Ao editar o perfil da organização, você precisa especificar todas as
propriedades dele, não apenas as que estiver editando.
Para editar a moeda padrão da organização, defina o valor currency
como o código ISO 4217 da moeda compatível que você quer definir como padrão.
Por exemplo, a chamada de API a seguir atualiza currency
para USD e a configuração do modelo fiscal para HYBRID
. Os campos atualizados estão destacados no exemplo. Para mais informações sobre as opções mostradas, consulte Propriedades de configuração do perfil da organização para a 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
Configurar os tipos de faturamento pré-pago e pós-pago usando a API
As contas de desenvolvedor podem ser configuradas para usar os seguintes tipos de faturamento: pré-pago, pós-pago ou ambos.
Com as contas pré-pagas, os desenvolvedores pagam antecipadamente pelo uso das suas APIs. Os fundos são deduzidos do saldo pré-pago do desenvolvedor, que é mantido por um provedor de pagamento integrado. O desenvolvedor precisa manter um saldo pré-pago suficiente para comprar as APIs.
Com as contas pós-pagas, os desenvolvedores são cobrados mensalmente (por meio de uma fatura) no fim do mês. O desenvolvedor paga pelo uso de produtos de API com base nas condições de pagamento definidas pelos planos incluídos na fatura.
Para configurar os tipos de faturamento pré-pago e pós-pago para sua organização, defina a propriedade supportedBillingType
como um dos
seguintes valores para indicar quais tipos são válidos: PREPAID
, POSTPAID
ou BOTH
. Se você definir o valor como BOTH
, o padrão será PREPAID
ao adicionar um desenvolvedor de apps ou empresa. Nesse caso, é possível definir explicitamente o tipo de faturamento de uma empresa ou de um desenvolvedor de apps usando a API, conforme descrito em Como gerenciar empresas e desenvolvedores de apps.
Exemplo:
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
Configurar o ciclo de faturamento usando a API
Para configurar o ciclo de faturamento da sua organização, defina a propriedade billingCycle
com um dos seguintes valores:
PRORATED
: o faturamento é baseado no número de dias que um produto de API é usado em um mês.CALENDAR_MONTH
: o faturamento é feito mensalmente.
Exemplo:
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
Propriedades de configuração do perfil da organização para a API
Com o perfil da organização, você pode definir as propriedades de configuração a seguir usando a API.
Nome | Descrição | Padrão | Obrigatório? |
---|---|---|---|
address |
O endereço da organização, que pode incluir o endereço, a cidade, o estado, o CEP, o país e uma indicação se esse é o endereço principal da organização. |
N/A | Não |
approveTrusted |
Esta sinalização não é usada. |
N/A | Não |
approveUntrusted |
Esta sinalização não é usada. |
N/A | Não |
billingCycle |
Período do ciclo de faturamento. O papel pode ser um dos seguintes:
Consulte Como configurar o ciclo de faturamento usando a API. |
N/A | Sim |
country |
Código ISO 3166-2 do país de operação da organização (por exemplo, BR para o Brasil). |
N/A | Sim |
currency |
Código ISO 4217 para a moeda "base" ou contábil que a organização usa (como USD para o dólar dos Estados Unidos). Para planos de participação na receita: a moeda especificada é usada no seu plano. Para planos de tabela de preços (modelo de cobrança): o mesmo se aplica aos planos de participação na receita, mas é possível alterar a configuração para qualquer moeda aceita pela organização. Para planos somente com taxas: é possível alterar a configuração de moeda para qualquer moeda aceita pela organização. |
N/A | Sim |
description |
Breve descrição da organização. |
N/A | Não |
hasBillingAdjustment |
Sinalização que especifica se os ajustes estão ativados. Quando ativado, é possível fazer ajustes nos detalhes de tráfego registrados pelos serviços da API referentes aos seus produtos. O valor pode ser um dos seguintes:
|
N/A | Não |
hasBroker |
Sinalização que especifica se a receita é baseada na rede líquida. O valor pode ser uma das seguintes opções:
|
N/A | Não |
hasSelfBilling |
Sinalização que direciona a monetização para gerar uma fatura de autofaturamento em vez de uma declaração de participação na receita. Uma fatura de autofaturamento é um documento financeiro que detalha o valor devido ao desenvolvedor do app. Ele funciona como uma fatura para o provedor da API em nome do desenvolvedor do app. O valor pode ser um destes:
|
N/A | Não |
hasSeparateInvoiceForProduct |
Sinalização que especifica se uma fatura separada é gerada para cada produto de API. O valor pode ser um destes:
|
N/A | Não |
id |
ID da organização. |
N/A | Não |
issueNettingStmt |
Sinalização que especifica se uma fatura é gerada durante a criação de documentos de faturamento. O valor pode ser um destes:
|
N/A | Não |
logoUrl |
URL do logotipo da organização. |
N/A | Não |
name |
Nome da organização. |
N/A | Sim |
netPaymentAdviceNote |
Nota do conselho de pagamento líquido. |
N/A | Não |
nettingStmtPerCurrency |
Sinalização que especifica se uma instrução de cálculo separada é gerada para cada moeda usada. O valor pode ser um destes:
|
N/A | Não |
regNo |
Número de registro da organização. O número que você inserir para essa propriedade é exibido na parte inferior dos documentos de faturamento. |
N/A | Não |
selfBillingAsExchOrg |
Se as faturas de autoatendimento estiverem ativadas, isso indica se elas estão habilitadas para organizações de troca. O valor pode ser um destes:
|
N/A | Não |
selfBillingForAllDev |
Se as faturas de faturamento automático estiverem ativadas, isso indica se elas estão ativadas para todos os desenvolvedores de apps. Por padrão, as faturas de autofaturamento são geradas apenas para os desenvolvedores de apps que assinaram um contrato com o provedor de API. O valor pode ser um destes:
|
false | Não |
separateInvoiceForFees |
Sinalização que especifica se uma fatura separada foi publicada para cobrança de taxas. O valor pode ser um destes:
|
false | Sim |
status |
Status da organização. Valores válidos:
|
N/A | Não |
supportedBillingType |
Modelo de pagamento do desenvolvedor usado para faturamento. O papel pode ser um dos seguintes:
Consulte Como configurar tipos de faturamento pré-pago e pós-pago usando a API. |
PRÉ-PAGA | Sim |
taxModel |
Observação:aplicável somente se você configurar planos de tarifas de participação na receita e quiser gerar documentos de faturamento. Modelo fiscal para planos de tarifas de participação na receita que identifica o tipo de documento de faturamento necessário. Valores válidos:
|
N/A | Sim |
taxNexus |
O país em que a organização está registrada para fins fiscais. |
N/A | Não |
taxRegNo |
Número de registro fiscal da organização ou número de registro do Imposto sobre Valor Agregado (IVA) da organização, se aplicável. Essa propriedade é opcional porque o número de registro fiscal ou do IVA não se aplica a todos os países. O número inserido para esse parâmetro é exibido na parte inferior dos documentos de faturamento. |
N/A | Não |
transactionRelayURL |
URL de outro sistema para o qual as transações podem ser redirecionadas, como um data warehouse. |
N/A | Não |
timezone |
O identificador de fuso horário para as operações da organização, como América/Nova_York ou Europa/Paris. Também há suporte para abreviações de fuso horário, como UTC, EST (Horário Padrão do Leste) ou CET (Horário da Europa Central). |
N/A | Sim |
Substituir as configurações do perfil de monetização de uma empresa ou de um desenvolvedor de apps
Substitua as configurações do perfil de monetização de uma empresa ou de um desenvolvedor de apps usando a interface ou a API, conforme descrito nas seções a seguir: