Organização
Tokens e escopos
Conceda a cada token apenas os escopos de que ele precisa; um endpoint fora dos escopos do token retorna 403.
Ao criar um token, você escolhe um ou mais escopos. Os escopos de leitura, sozinhos, não mexem no seu saldo: operações que geram cobrança exigem um escopo próprio (orders:write), e alterações de configuração, outro (proxies:write).
Escopos
| Escopo | Nome | Descrição |
|---|---|---|
orders:read | Informações do serviço | Dias restantes, tráfego usado, número de requisições e de erros; catálogo, estoque e cotação de preço. |
proxies:read | Lista de proxies | Endereços dos proxies e dados de acesso. Inclui credenciais; conceda com cuidado. |
logs:read | Logs | Logs de requisições. O seu plano também precisa incluir acesso a logs. |
orders:write | Criação de pedidos | Abre novos pedidos de proxy e DEBITA UM VALOR DO SEU SALDO. Conceda apenas à integração que realmente vai fazer compras. |
proxies:write | Configurações de proxy | Altera as configurações de serviços existentes, como o nome do serviço e o limite de tráfego. Não gera cobrança. |
Quais endpoints cada escopo libera
orders:read
- GET
/meInformações do token e da organização - GET
/catalogCatálogo - GET
/locationsLocalizações - GET
/target-urlsDomínios de destino - GET
/stockVerificação de estoque - GET
/pricingCotação de preço - GET
/ordersListar serviços - GET
/orders/{id}Detalhes do serviço - GET
/orders/{id}/usage-historyHistórico de uso
proxies:read
- GET
/orders/{id}/accessListas de acesso - GET
/orders/{id}/connectionDados de acesso - GET
/orders/{id}/proxiesLista de proxies
logs:read
orders:write
- POST
/ordersCriar pedido - POST
/orders/{id}/renewRenovar serviço - PUT
/orders/{id}/auto-renewRenovação automática
proxies:write
Conjuntos de escopos recomendados
| Integração | Escopos |
|---|---|
| Monitoramento de uso e de vencimento | orders:read |
| Repasse da lista de proxies ao cliente | orders:read, proxies:read |
| Análise de logs | orders:read, logs:read |
| Compra e renovação automáticas | orders:read, orders:write, proxies:read |
| Automação de nome e limite de tráfego | orders:read, proxies:write |
Quando o nome de usuário e a senha são gerados automaticamente no pedido, o token também precisa ter proxies:read para que eles sejam retornados na resposta.