A resposta curta: o endereço e as operações são os mesmos nos dois modos: é a chave que decide. Uma chave sandbox_ lê os dados verdadeiros da conta, mas as alterações são simuladas e nunca cobram. Uma chave prod_ lê e altera a conta a sério. Passar para produção é trocar a chave.
Os dois modos lado a lado
|
Sandbox (sandbox_) |
Produção (prod_) |
| Leituras |
Dados verdadeiros da conta |
Dados verdadeiros da conta |
| Alterações |
Simuladas |
Alteram a conta |
| Cobranças |
Nunca |
Sim, do saldo, dentro do limite de gastos |
| Cabeçalho X-API-Mode na resposta |
sandbox |
production |
| Para que serve |
Desenvolver e testar sem risco |
O programa já pronto |
|
Sandbox não quer dizer dados de brincar. Uma chave sandbox_ lê os seus domínios, facturas e contactos verdadeiros. Guarde-a com o mesmo cuidado que uma chave de Produção.
|
Como saber que a resposta foi simulada
| 1 |
Todas as respostas com chave trazem o cabeçalho X-API-Mode, com sandbox ou production.
|
|
| 2 |
As escritas simuladas trazem também X-API-Simulated: true.
|
|
| 3 |
O campo mode de GET /v1/token diz o modo da chave, e writes_simulated diz se as escritas estão a ser simuladas.
|
|
O que a Sandbox simula, área a área
| Área |
Com uma chave Sandbox |
| Domínios e extras |
A compra não acontece, e a resposta diz se o saldo chegaria e se cabia no limite de gastos. |
| Facturas |
credit_sufficient e within_spending_limit dizem se o pagamento passaria. Nada é cobrado. |
| Hospedagem e e-mail |
A API confere o pedido, mas não chega ao servidor. O que depende do servidor, como saber se algo já existe, só se confere em Produção. |
| Servidores VPS |
Nenhum servidor é tocado. A senha de root devolvida não é verdadeira. |
| Suporte |
Nenhum pedido de suporte é criado, e o id vem a null. |
| SMS |
A mensagem é validada, mas não é enviada nem gasta créditos. |
Há uma excepção importante: as protecções do domínio do e-mail da conta (o 409 account_email_domain) respondem também em Sandbox, para que o seu teste mostre o que vai acontecer em Produção.
Enquanto a API está em preparação
Nesta fase, nem as chaves prod_ alteram a conta nem cobram: as escritas são simuladas e writes_simulated vem a true. As chaves criadas durante a preparação, de qualquer modo, são revogadas quando a API abrir, e o dono da conta recebe um aviso por e-mail. Depois disso, crie chaves novas.
Passar o programa para Produção
| 1 |
Teste tudo em Sandbox, incluindo os erros: chave sem permissão, saldo insuficiente, nome de domínio inválido.
|
|
| 2 |
Crie uma chave prod_ na página API do Meu Interweb, com as permissões mínimas, um limite de gastos à medida e, se puder, lista de IPs.
|
|
| 3 |
Troque a chave no programa. No pedido, o prefixo é a única diferença.
|
|
| 4 |
Envie o cabeçalho X-API-Mode: production nos pedidos. Se a chave não for desse modo, a API recusa com invalid_request e a razão mode_mismatch, e o programa nunca corre com a chave errada.
|
|
curl https://api.interweb.co.mz/v1/domains -H "Authorization: Bearer $RLX_API_KEY" -H "X-API-Mode: production"
|
Os limites de algumas áreas são à parte em Sandbox. Na hospedagem e nos servidores, os pedidos com chave sandbox_ não gastam os limites de Produção. Os outros limites estão em os limites de pedidos da API.
|
|
Comece sempre pela Sandbox: crie uma chave sandbox_ e teste o programa sem tocar na conta nem gastar saldo.
Criar uma chave
|
|
VEJA TAMBÉM
Criar uma chave da API: nome, modo, permissões, validade, lista de IPs e limite de gastos
A nossa API numa página: o que pode automatizar na sua conta, área a área
Limites de pedidos da API: por chave, por conta e por tarefa, os cabeçalhos e o que fazer num 429
Os códigos de erro da nossa API: o que quer dizer cada um, e quais vale a pena repetir
Permissões sensíveis da API e limite de gastos: pagar, comprar, reinstalar, entrar no cPanel
Cuidar das suas chaves da API: uma por programa, validade, revogar e substituir
|
PRODUTO RECOMENDADO Hospedagem de sites com cPanel Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 321,75 MT/mês (plano de 3 anos, com cupão) Ver planos |
Português
English
