Gerencie o perfil da organização

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
info

As seções a seguir apresentam o perfil da organização e descrevem como gerenciá-lo usando a IU 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 configura o perfil da sua organização.

Edite 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 tributário.

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 (proporcional ou mês civil)
  • Moeda base
  • Modelo tributário usado pela sua organização

É possível gerenciar o perfil da organização usando a IU 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 IU do Edge:

  1. Faça login em apigee.com/edge.
  2. Selecione Publicar > Monetização > Perfil da organização na barra de navegação à esquerda.

A página do perfil da organização é exibida.

Conforme destacado na figura, a página do perfil da organização permite:

  • Ver as configurações atuais do perfil da organização
  • Edite as configurações do perfil da organização, incluindo:

Classic Edge (nuvem privada)

Para acessar a página "Perfil da organização" usando a IU clássica do Edge:

  1. 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.
  2. Selecione Administrador > Perfil da organização na barra de navegação superior.

A página do perfil da organização é exibida.

Na página "Perfil da organização", é possível:

  • Ver as configurações atuais do perfil da organização
  • Edite as configurações do perfil da organização, incluindo:

Editar o perfil da organização usando a interface

Para editar o perfil da organização usando a interface:

  1. Acesse a página do perfil da organização.
  2. Clique em Editar.
  3. Em Nome e informações, edite o nome da organização e o país de operação.
  4. Em Tributos e moeda, edite os seguintes campos:
    Campo Descrição
    Modelo tributário

    Observação:isso só se aplica se você configurar planos de tarifas de participação na receita e quiser gerar documentos de faturamento.

    Modelo tributário para planos de tarifas de participação na receita que identifica o tipo de documentos de faturamento necessários.

    Valores válidos:

    • Divulgado: o provedor de API atua como um agente divulgado do desenvolvedor. A receita bruta (incluindo tributos sobre vendas) coletada do usuário final é transmitida ao desenvolvedor. A comissão do provedor da API é coletada do desenvolvedor na forma de uma fatura de comissão. O provedor da API não lida com o imposto sobre vendas coletado do usuário final, e é responsabilidade do desenvolvedor informar esse imposto.
    • Não divulgado: o provedor de API atua como um agente não divulgado do desenvolvedor, deduz o imposto coletado dos usuários finais e o paga aos tributos locais. O desenvolvedor fatura o provedor de API pela participação na receita líquida devida ao desenvolvedor (menos os impostos sobre vendas e a comissão do provedor de 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 de tributos locais em nome do desenvolvedor. O provedor de API passa a receita restante para o desenvolvedor e envia faturas para cobranças de comissão.
    Moeda

    Moedas aceitas pela sua organização. Para planos de participação na receita, tabela de preços e somente taxa, a moeda padrão é usada no seu plano de tarifas. Ao criar uma tabela de preços ou um plano somente de taxas, você pode mudar a moeda usada selecionando uma opção em uma lista de moedas aceitas. Se quiser, defina o valor mínimo de recarga que os desenvolvedores de apps podem adicionar ao saldo da conta pré-paga para cada moeda.

    Para adicionar uma moeda:

    1. Clique em Adicionar moeda.
    2. Selecione uma moeda no menu suspenso do campo Moeda.
    3. Se quiser, 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.
    4. Clique em Adicionar.
    5. Se quiser, clique no botão de opção associado para definir como a moeda padrão.
    6. Repita as etapas para adicionar outras moedas.

    Para excluir uma moeda, posicione o cursor sobre ela e clique em .

  5. Gerencie os termos e condições, conforme descrito em Gerenciar termos e condições usando a interface.
  6. 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.

Ver o perfil da organização usando a API

Para ver o perfil da sua organização, emita 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, é necessário especificar todas as propriedades, não apenas as que você está editando.

Para editar a moeda padrão da organização, defina o valor currency como o código da moeda ISO 4217 que você quer definir como padrão.

Por exemplo, a chamada de API a seguir atualiza a currency para USD e a configuração do modelo tributário 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 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 pagamentos integrado. O desenvolvedor precisa manter um saldo pré-pago suficiente para comprar as APIs.

Com as contas pós-pagas, os desenvolvedores recebem uma fatura mensal no fim do mês. O desenvolvedor paga pelo uso dos 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 da sua organização, defina a propriedade supportedBillingType como um dos seguintes valores para indicar quais tipos de faturamento 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 uma 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 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 como um dos seguintes valores:

  • PRORATED: o faturamento é baseado no número de dias em que um produto de API é usado em um mês civil.
  • 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, é possível definir as seguintes propriedades de configuração usando a API.

Nome Descrição Padrão Obrigatório?
address

Endereço da organização, que pode incluir rua, cidade, estado, CEP, país e uma indicação se esse é o endereço principal da organização.

N/A Não
approveTrusted

Essa flag não é usada.

N/A Não
approveUntrusted

Essa flag não é usada.

N/A Não
billingCycle

Período do ciclo de faturamento. O papel pode ser um dos seguintes:

  • PROPORCIONAL: o faturamento é baseado no número de dias em que um produto de API é usado em um mês civil.
  • CALENDAR_MONTH: o faturamento é mensal.

Consulte 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, como BR para Brasil.

N/A Sim
currency

Código ISO 4217 da moeda "base" ou contábil usada pela organização, como USD para 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. No entanto, é possível mudar a configuração de moeda para qualquer moeda aceita pela organização.

Para planos somente com taxas: é possível mudar 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

Flag que especifica se os ajustes estão ativados. Se ativado, você poderá fazer ajustes nos detalhes de tráfego registrados pelos Serviços de API para seus produtos de API. O valor pode ser um dos seguintes:

  • true: os ajustes estão ativados.
  • false: os ajustes não estão ativados.
N/A Não
hasBroker

Flag que especifica se a receita é líquida. O valor pode ser um dos seguintes:

  • true: a receita é baseada no valor líquido.
  • false: a receita não é baseada no valor líquido.
N/A Não
hasSelfBilling

Flag que direciona a monetização para gerar uma fatura de auto-faturamento em vez de um extrato de participação na receita. Uma fatura de auto-faturamento é um documento financeiro que detalha o valor devido ao desenvolvedor de apps. Ele funciona como uma fatura para o provedor de API em nome do desenvolvedor de app. O valor pode ser um dos seguintes:

  • true: gera faturas de autofaturamento em vez de extratos de participação na receita.
  • false: desativa as faturas de autofaturamento.
N/A Não
hasSeparateInvoiceForProduct

Flag que especifica se uma fatura separada é gerada para cada produto de API. O valor pode ser um dos seguintes:

  • true: uma fatura separada é gerada para cada produto de API.
  • false: não é gerada uma fatura separada para cada produto de API.
N/A Não
id

ID da organização.

N/A Não
issueNettingStmt

Flag que especifica se uma declaração de compensação é gerada ao criar documentos de faturamento. O valor pode ser um dos seguintes:

  • true: o extrato de compensação é gerado ao criar documentos de faturamento.
  • false: o extrato de compensação não é gerado ao criar documentos de faturamento.
N/A Não
logoUrl

URL do logotipo da organização.

N/A Não
name

Nome da organização.

N/A Sim
netPaymentAdviceNote

Aviso de pagamento líquido.

N/A Não
nettingStmtPerCurrency

Flag que especifica se uma demonstração de compensação separada é gerada para cada moeda usada. O valor pode ser um dos seguintes:

  • true: um extrato de compensação separado é gerado para cada moeda usada.
  • false: não gera um extrato de compensação separado para cada moeda usada.
N/A Não
regNo

Número de registro da organização. O número inserido para essa propriedade é exibido na parte de baixo dos documentos de faturamento.

N/A Não
selfBillingAsExchOrg

Se as faturas de autocobrança estiverem ativadas, indica se elas estão ativadas para organizações de troca. O valor pode ser um dos seguintes:

  • true: as faturas de autocobrança estão ativadas para organizações de troca.
  • false: as faturas de autocobrança não estão ativadas para organizações de troca.
N/A Não
selfBillingForAllDev

Se as faturas de autocobrança estiverem ativadas, indica se elas estão ativadas para todos os desenvolvedores de apps. Por padrão, as faturas de autocobrança são geradas apenas para desenvolvedores de apps que assinaram um contrato com o provedor de API. O valor pode ser um dos seguintes:

  • true: as faturas de autocobrança estão ativadas para todos os desenvolvedores de apps.
  • false: as faturas de autocobrança não estão ativadas para todos os desenvolvedores de apps.
falso Não
separateInvoiceForFees

Flag que especifica se uma fatura separada é publicada para taxas. O valor pode ser uma das seguintes opções:

  • true: uma fatura separada é publicada para as taxas.
  • false: Separate invoice is not published for fees.
falso Sim
status

Status da organização. Valores válidos:

  • ATIVA: a conta da organização está registrada na monetização e disponível para uso.
  • INATIVA: a conta da organização está registrada na monetização, mas não está disponível para uso.
N/A Não
supportedBillingType

Modelo de pagamento do desenvolvedor usado para faturamento. O papel pode ser um dos seguintes:

  • PRÉ-PAGO: o desenvolvedor paga antecipadamente pelo uso de um produto de API. Os fundos são deduzidos do saldo do desenvolvedor quando o produto de API é usado. O desenvolvedor precisa manter um saldo pré-pago suficiente para comprar o produto de API.
  • POSTPAID: o desenvolvedor recebe uma fatura mensal pelo uso de produtos de API. O desenvolvedor paga pelo uso dos produtos de API com base nas condições de pagamento definidas pelos planos incluídos na fatura.
  • BOTH: aceita qualquer tipo de faturamento. O padrão é PREPAID.

Consulte Configurar tipos de faturamento pré-pago e pós-pago usando a API.

PRÉ-PAGO Sim
taxModel

Observação:isso só se aplica se você configurar planos de tarifas de participação na receita e quiser gerar documentos de faturamento.

Modelo tributário para planos de tarifas de participação na receita que identifica o tipo de documentos de faturamento necessários.

Valores válidos:

  • Divulgado: o provedor de API atua como um agente divulgado do desenvolvedor. A receita bruta (incluindo tributos sobre vendas) coletada do usuário final é transmitida ao desenvolvedor. A comissão do provedor da API é coletada do desenvolvedor na forma de uma fatura de comissão. O provedor da API não lida com o imposto sobre vendas coletado do usuário final, e é responsabilidade do desenvolvedor informar esse imposto.
  • Não divulgado: o provedor de API atua como um agente não divulgado do desenvolvedor, deduz o imposto coletado dos usuários finais e o paga aos tributos locais. O desenvolvedor fatura o provedor de API pela participação na receita líquida devida ao desenvolvedor (menos os impostos sobre vendas e a comissão do provedor de 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 de tributos locais em nome do desenvolvedor. O provedor de API passa a receita restante para o desenvolvedor e envia faturas para cobranças de comissão.
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 ou de 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 de baixo dos documentos de faturamento.

N/A Não
transactionRelayURL

URL de outro sistema para o qual as transações podem ser retransmitidas, como um data warehouse.

N/A Não
timezone

O identificador do fuso horário das operações da organização, como America/New_York ou Europe/Paris. Abreviações de fuso horário, como UTC, EST (horário padrão do leste dos EUA) ou CET (horário da Europa Central), também são aceitas.

N/A Sim

Substituir as configurações de perfil de monetização de uma empresa ou desenvolvedor de app

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: