Gerencie o perfil da organização

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

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

Você precisa editar o perfil da organização para adicionar ou atualizar informações sobre ela, conforme apropriado. Por exemplo, talvez seja necessário atualizar o tipo de faturamento, as configurações de moeda ou o modelo fiscal.

Configurar 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 Entenda o tipo de faturamento
  • Ciclo de faturamento (proporcional ou por mês)
  • Moeda base
  • Modelo fiscal usado pela sua organização

Você pode gerenciar o perfil da sua organização usando a interface e a API, conforme descrito em nas seções a seguir.

Acesse 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 de 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 Perfil da organização é exibida.

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

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

Edge clássico (nuvem privada)

Para acessar a página de perfil da organização usando a IU do Classic 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 Perfil da organização é exibida.

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

  • Ver as configurações atuais do perfil da organização
  • Editar 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 IU:

  1. Acesse a página 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 fiscal

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

    Modelo fiscal 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 da desenvolvedor. A receita bruta (incluindo tributos sobre vendas) coletada do usuário final é de passados para o desenvolvedor. A comissão do provedor da API é coletada pelo o desenvolvedor na forma de uma fatura de comissão. O provedor da API não lida com a tributo sobre vendas coletado do usuário final, e é responsabilidade do desenvolvedor para informar o tributo sobre vendas.
    • Não divulgado: o provedor de API atua como um agente não revelado do o desenvolvedor, deduz o tributo recolhido dos usuários finais e o paga ao autoridades fiscais locais. O desenvolvedor fatura o provedor da API com a receita líquida compartilhada devido ao desenvolvedor (menos impostos sobre vendas e o valor do comissão).
    • Híbrido: o provedor de API atua como um agente divulgado da desenvolvedor. No entanto, o provedor da API paga o tributo sobre vendas coletado do os assinantes às autoridades fiscais locais em nome do desenvolvedor. A API o provedor envia a receita restante ao desenvolvedor e, em seguida, as faturas 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 taxas, a moeda padrão é usada para seu plano de tarifas. Ao criar uma tabela de preços ou um plano somente de taxas, é possível alterar a moeda para usar, selecionando de uma lista de moedas suportadas. Também é possível 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:

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

    Para excluir uma moeda, posicione o cursor sobre a moeda que você quer excluir e clique em .
  5. Gerencie os Termos e Condições, conforme descrito em Como 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.

Acessar o perfil da organização usando a API

Visualize o perfil da sua organização emitindo 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, mostrado, 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

Editar 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 todos os propriedades do perfil da organização, não apenas aquelas que você está editando.

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

Por exemplo, a chamada de API a seguir atualiza o currency para USD e o modelo fiscal. como HYBRID (os campos atualizados são destacados no exemplo). Para mais informações sobre as opções mostradas, consulte 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 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 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 da sua organização, defina a propriedade supportedBillingType como um dos valores a seguir 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 quando você 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 Gerenciamento de 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

O perfil da organização permite que você defina as propriedades de configuração a seguir usando a API.

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

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

 N/A Não
approveTrusted

Essa sinalização não é usada.

 N/A Não
approveUntrusted

Essa sinalização não é usada.

 N/A Não
billingCycle

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

  • PRORATADO: o faturamento é baseado no número de dias que um produto de API é usado em um mês.
  • AGENDA_MÊS: o faturamento é feito mensalmente.

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

 N/A Sim
currency

Código ISO 4217 para a "base" ou moeda contábil que a organização usa (como USD para os Estados Unidos) dólar).

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 alterar a configuração de moeda para qualquer moeda aceita pelo organização.

Para planos que só pagam taxas: é possível mudar a configuração para qualquer moeda aceita pelo da 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. Se ativado, é possível fazer ajustes nos detalhes de tráfego registrados pelos serviços de API para seus produtos de API, pode ser um destes:

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

Sinalização que especifica se a receita é baseada no valor líquido. O valor pode ser o seguinte:

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

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

  • Verdadeiro: gera faturas de autofaturamento em vez de declarações de divisão da receita.
  • false: desativa as faturas.
 N/A Não
hasSeparateInvoiceForProduct

Sinalização que especifica se uma fatura separada é gerada para cada produto da API. A pode ser um destes:

  • 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

Sinalização que especifica se um extrato é gerado na criação de faturamento documentos. O valor pode ser um dos seguintes:

  • true: o extrato de rede é gerado na criação de documentos de faturamento.
  • false: o extrato de rede não é gerado na criação de 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

Observação sobre o pagamento líquido.

 N/A Não
nettingStmtPerCurrency

Sinalizador que especifica se uma instrução netting separada é gerada para cada moeda utilizada. O valor pode ser um dos seguintes:

  • Verdadeiro: é gerado um extrato separado para cada moeda usada.
  • false: não é gerada uma declaração de compensação separada para cada moeda usada.
 N/A Não
regNo

Número de registro da organização O número que você insere para essa propriedade é exibidos na parte inferior dos documentos de faturamento.

 N/A Não
selfBillingAsExchOrg

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

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

Se as faturas de autofaturamento estiverem ativadas, indica se elas estão ativadas para todos desenvolvedores de apps. Por padrão, as faturas de autofaturamento são geradas apenas para os desenvolvedores de apps que têm assinou um contrato com o provedor da API. O valor pode ser um dos seguintes:

  • Verdadeiro: as faturas de autofaturamento estão ativadas para todos os desenvolvedores de apps.
  • Falso: as faturas de autofaturamento não estão ativadas para todos os desenvolvedores de apps.
 falso Não
separateInvoiceForFees

Sinalização que especifica se uma fatura separada é publicada para taxas. O valor pode ser um dos seguintes:

  • Verdadeiro: uma fatura separada é publicada para taxas.
  • false: faturas separadas não são publicadas para taxas.
 falso Sim
status

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

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

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

  • PRÉ-PAGA: o desenvolvedor paga antecipadamente pelo uso de um produto de API. Os fundos são deduzido do saldo do desenvolvedor quando o produto da API é usado. O desenvolvedor precisa manter um saldo pré-pago suficiente para comprar o produto de API.
  • POSTPAID: o desenvolvedor é cobrado mensalmente (por uma fatura) pelo uso da API produtos. O desenvolvedor paga pelo uso dos produtos de API com base nas condições de pagamento definidas pelo(s) plano(s) incluído(s) na fatura.
  • BOTH: aceita qualquer tipo de faturamento. O padrão é PREPAID.

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

PRÉ-PAGA Sim
taxModel

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

Modelo fiscal 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 da desenvolvedor. A receita bruta (incluindo tributos sobre vendas) coletada do usuário final é de passados para o desenvolvedor. A comissão do provedor da API é coletada pelo o desenvolvedor na forma de uma fatura de comissão. O provedor da API não lida com a tributo sobre vendas coletado do usuário final, e é responsabilidade do desenvolvedor para informar o tributo sobre vendas.
  • Não divulgado: o provedor de API atua como um agente não revelado do o desenvolvedor, deduz o tributo recolhido dos usuários finais e o paga ao autoridades fiscais locais. O desenvolvedor fatura o provedor da API com a receita líquida compartilhada devido ao desenvolvedor (menos impostos sobre vendas e o valor do comissão).
  • Híbrido: o provedor de API atua como um agente divulgado da desenvolvedor. No entanto, o provedor da API paga o tributo sobre vendas coletado do os assinantes às autoridades fiscais locais em nome do desenvolvedor. A API o provedor envia a receita restante ao desenvolvedor e, em seguida, as faturas 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 da organização ou registro do Imposto sobre Valor Agregado (IVA) se aplicável. Esta propriedade é opcional porque o número de registro fiscal ou O número de registro do IVA não se aplica a todos os países. O número que você inserir é 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 uma conta de armazém.

 N/A Não
timezone

O identificador de fuso horário das operações da organização, como América/Nova_York ou Europa/Paris. Abreviações de fuso horário, como UTC, EST (leste) horário padrão, ou CET (horário da Europa Central), também são compatíveis.

 N/A Sim

Substituir as configurações do perfil de monetização de uma empresa ou um desenvolvedor de apps

Modificar 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 seguintes seções: