Você está vendo a documentação do Apigee Edge.
Acesse a
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 define as moedas e a moeda padrão aceita pela sua organização.
É possível ver as moedas aceitas pela sua organização, adicionar ou excluir moedas compatíveis (se elas não forem usadas por um desenvolvedor ou por um plano de tarifas).
Como gerenciar moedas suportadas usando a interface
Gerencie as moedas suportadas e defina a moeda padrão na seção "Tributos e moedas" da página do 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 moedas aceitas usando a API, conforme descrito nas seções a seguir.
Como conferir moedas aceitas usando a API
Confira uma moeda específica aceita pela sua organização ou todas as moedas aceitas por ela.
Para acessar uma moeda específica 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. 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 consultar 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 compatíveis usando a API
Adicione moedas aceitas emitindo uma solicitação POST para
/mint//organizations/{org_name}/supported-currencies. Para cada moeda compatível 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 o dólar dos Estados Unidos.
- Nome de exibição.
- Descrição.
- Indica se a moeda é virtual ou não.
- Status da moeda, ou seja, se ela está disponível para uso.
- Organização à qual a moeda aceita será adicionada.
Também é possível definir:
- Limite de crédito para uma moeda compatível (somente desenvolvedores pós-pagos).
- Recarga mínima para uma moeda aceita (somente desenvolvedores pré-pagos).
Consulte Propriedades de configuração de moeda compatíveis para mais informações.
Por exemplo, o código a seguir adiciona uma moeda compatível com 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
Para definir a moeda padrão da organização, defina o valor de currency como um código de moeda ISO 4217
compatível ao editar o perfil da organização, conforme descrito em Como gerenciar o perfil
da organização usando a API.
Editar uma moeda compatível 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 que será atualizada. Você precisa especificar no corpo da solicitação as propriedades atualizadas,
bem como 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 compatível (as propriedades atualizadas estã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
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. 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 da API
A tabela a seguir resume as propriedades de configuração que podem ser definidas usando a API.
| Nome | Descrição | Padrão | Obrigatório? |
|---|---|---|---|
| creditLimit |
Essa propriedade é válida somente para desenvolvedores pós-pagos. O limite de crédito para a moeda aceita. |
N/A | Não |
| descrição |
Uma descrição da moeda aceita. |
N/A | Sim |
| displayName |
O nome a ser exibido para a moeda aceita. |
N/A | Sim |
| minimumTopupAmount |
Essa propriedade é válida apenas para desenvolvedores pré-pagos. Valor mínimo que os desenvolvedores podem adicionar ao saldo da conta pré-paga na moeda especificada. |
N/A | Não |
| name |
É o código ISO 4217 da moeda, como USD para o dólar americano. |
N/A | Sim |
| organização |
A organização para a moeda aceita. |
N/A | Sim |
| reconhecimento |
O status da moeda aceita. Valores válidos:
|
N/A | Sim |
| virtualCurrency |
Indica se a moeda aceita é virtual. Valores válidos:
|
N/A | Sim |