Gerenciar moedas compatíveis

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

Introdução

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

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

Como gerenciar moedas aceitas usando a interface

Gerencie as moedas aceitas e defina a moeda padrão na coluna "Tax and Currency" da página "Perfil da organização". Consulte Como gerenciar o perfil da organização usando a IU para ver detalhes.

Como gerenciar moedas aceitas usando a API

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

Como visualizar moedas aceitas usando a API

Consultar uma moeda individual suportada pela sua organização ou todas as moedas com suporte da sua organização.

Para visualizar uma moeda individual aceita pela sua organização, envie uma solicitação GET para /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, em que {supportedCurrency_id} é a identificação da moeda aceita a ser visualizado. 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 visualizar todas as moedas aceitas pela sua organização, envie 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 definir a moeda padrão usando a API

Defina a moeda padrão da organização definindo o valor de currency como uma moeda ISO 4217 compatível ao editar o perfil da organização, conforme descrito em Como gerenciar a organização perfil usando a API.

Como editar uma moeda compatível usando a API

Edite uma moeda compatível emitindo uma solicitação PUT para /mint/organizations/{org_name}/{supportedCurrencyId}, em que {supportedCurrency_id} é a identificação da moeda aceita a ser atualizado. É necessário especificar no corpo da solicitação as propriedades atualizadas e o ID da moeda aceita. Por exemplo, a chamada de API a seguir edita a descrição e o nome de exibição de uma moeda aceita (as propriedades atualizadas são destacados 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

Excluir uma moeda aceita usando a API

Exclua uma moeda suportada 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. Por 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.