Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
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 aceitas pela sua organização.
Você pode conferir as moedas aceitas pela sua organização, adicionar ou excluir moedas (se elas não forem usadas por um desenvolvedor ou plano de tarifas).
Como gerenciar as moedas aceitas usando a interface
Gerenciar as moedas compatíveis e definir a moeda padrão na seção "Impostos e moeda" da página do perfil da organização. Consulte Como gerenciar o perfil da organização usando a IU para ver mais detalhes.
Como gerenciar moedas aceitas usando a API
Gerencie as moedas compatíveis usando a API, conforme descrito nas seções a seguir.
Como conferir as moedas aceitas usando a API
Confira uma moeda individual ou todas as moedas compatíveis com sua organização.
Para conferir 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 que será
mostrada. 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 ver 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 adicionar moedas aceitas usando a API
Adicione moedas aceitas emitindo uma solicitação POST para
/mint//organizations/{org_name}/supported-currencies. Para cada moeda com suporte adicionada,
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 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 ou não.
- Organização para a qual a moeda vai ser adicionada.
Também é possível definir:
- Limite de crédito para uma moeda aceita (somente para desenvolvedores pós-pagos).
- Recarga mínima para uma moeda com suporte (somente para desenvolvedores pré-pagos).
Consulte as 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
Defina a moeda padrão da organização definindo o valor 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.
Como editar uma moeda aceita 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 compatível a ser atualizada. É necessário especificar as propriedades atualizadas no corpo da solicitação, 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 aceita (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
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. 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.
| Nome | Descrição | Padrão | Obrigatório? |
|---|---|---|---|
| creditLimit |
Essa propriedade se aplica apenas a desenvolvedores pós-pagos. O limite de crédito na moeda aceita. |
N/A | Não |
| descrição |
Uma descrição da moeda aceita. |
N/A | Sim |
| displayName |
O nome a ser mostrado para a moeda aceita. |
N/A | Sim |
| minimumTopupAmount |
Essa propriedade se aplica apenas a desenvolvedores pré-pagos. Valor mínimo que os desenvolvedores podem adicionar ao saldo da conta pré-paga na moeda especificada. |
N/A | Não |
| nome |
O código ISO 4217 da moeda, como USD para dólar americano. |
N/A | Sim |
| organização |
A organização da moeda aceita. |
N/A | Sim |
| status |
O status da moeda aceita. Valores válidos:
|
N/A | Sim |
| virtualCurrency |
Indica se a moeda aceita é virtual. Valores válidos:
|
N/A | Sim |