Gerenciar moedas compatíveis

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

Introdução

Como parte da configuração inicial da monetização, a equipe de configuração do Apigee Edge configura as moedas e a moeda padrão aceita pela sua organização.

É possível conferir as moedas aceitas pela sua organização, adicionar ou excluir moedas aceitas (se elas não forem usadas por um desenvolvedor ou um plano de tarifas).

Como gerenciar moedas aceitas usando a IU

Gerencie as moedas aceitas e defina a moeda padrão na seção "Impostos e moeda" da página "Perfil da organização". Para mais detalhes, consulte Como gerenciar o perfil da organização usando a IU.

Como gerenciar moedas aceitas usando a API

Gerencie as moedas aceitas usando a API, conforme descrito nas seções a seguir.

Como conferir moedas aceitas usando a API

Confira uma moeda aceita pela sua organização ou todas as moedas aceitas pela sua organização.

Para conferir uma moeda aceita pela sua organização, emita uma solicitação GET para /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, em que {supportedCurrency_id} é a identificação da moeda aceita a ser conferida. Exemplo:

curl -X GET -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password

Para conferir todas as moedas aceitas pela sua organização, emita uma solicitação GET para /mint/organizations/{org_name}/supported-currencies. Exemplo:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
  -H "Accept: application/json"  \
-u email:password

Veja a seguir um exemplo de resposta:

{
"supportedCurrency" : [ {
    "description" : "US Dollar",
    "displayName" : "US Dollar",
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    "status" : "ACTIVE",
    "virtualCurrency" : false
  }, {
    "creditLimit" : 5000.0000,
    "description" : "Euro",
    "displayName" : "Euro",
    "id" : "eur",
    "name" : "EUR",
    "organization" : {
      ...
    },
    "status" : "INACTIVE",
    "virtualCurrency" : false  
  } ],
  "totalRecords" : 2
}

Como adicionar moedas aceitas usando a API

Adicione moedas aceitas emitindo uma solicitação POST para /mint//organizations/{org_name}/supported-currencies. Para cada moeda aceita que você adicionar, especifique as seguintes informações no corpo da solicitação:

• Nome da moeda aceita. O nome é o código ISO 4217 da moeda, como USD para dólar americano.
• Nome de exibição.
• Descrição.
• Se a moeda é virtual ou não.
• Status da moeda, ou seja, se ela está disponível para uso ou não.
• Organização para a qual a moeda aceita será adicionada.

Opcionalmente, é possível definir:

• Limite de crédito para uma moeda aceita (somente para desenvolvedores pós-pagos).
• Recarga mínima para uma moeda aceita (somente para desenvolvedores pré-pagos).

Consulte Propriedades de configuração de moedas aceitas para mais informações.

Por exemplo, o seguinte adiciona uma moeda aceita para uma organização:

curl -H "Content-Type: application/json" -X POST -d \
  '{
     "description": "US Dollar",
     "displayName": "US Dollar",
     "virtualCurrency": "false",
     "name": "USD",
     "organization": {
       "id": "{org_name}"
     },
     "status": "ACTIVE"
  }' \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
  -u email:password

Como definir a moeda padrão usando a API

Defina a moeda padrão da organização definindo o valor currency como um código de moeda ISO 4217 aceito ao editar o perfil da organização, conforme descrito em Como gerenciar o perfil da organização usando a API.

Como editar uma moeda aceita usando a API

Edite uma moeda aceita emitindo uma solicitação PUT para /mint/organizations/{org_name}/{supportedCurrencyId}, em que {supportedCurrency_id} é a identificação da moeda aceita a ser atualizada. É necessário especificar no corpo da solicitação as propriedades atualizadas e o ID da moeda aceita. Por exemplo, a seguinte chamada de API edita a descrição e o nome de exibição de uma moeda aceita (as propriedades atualizadas são destacadas no exemplo):

curl -H "Content-Type: application/json" -X PUT -d \
  '{
     "description": "United States Dollar",
     "displayName": "United States Dollar",
     "id": "usd",
     "name": "USD",
     "organization": {
       "id": "{org_name}"
     },
     "status" : "ACTIVE",
     "virtualCurrency": "false"
  }' \
  "https://api.enterprise.apigee.com/v1/mint/organization/{org_name}/supported-currencies/usd" -d \
  -u email:password

Como excluir uma moeda aceita usando a API

Exclua uma moeda aceita emitindo uma solicitação DELETE para /mint/organizations/{org_name}/supported-currencies/{currency_id}, em que {currency_id} é a identificação da moeda aceita a ser excluída. Exemplo:

curl -X DELETE -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
  -u email:password

Propriedades de configuração de moeda para a API

A tabela a seguir resume as propriedades de configuração que podem ser definidas usando a API.