Pular para o conteúdo

O painel da Proxynet funciona com um modelo de organização como o do GitHub. Uma organização reúne os serviços, o saldo, o plano e os tokens. Os membros autorizados da organização criam e gerenciam proxies no painel; a API faz o mesmo por meio de um token.

O que pertence à organização

Serviços

Todos os pedidos de proxy são abertos na organização. GET /orders lista os serviços da organização.

Saldo e plano

Os pedidos são pagos com o saldo da organização; os preços vêm do plano (tier) da organização.

Tokens de API

O token é criado em uma organização e só vê os serviços dela.

Atividade

Toda alteração feita pela API é registrada na página Atividade da organização.

A qual organização o token está vinculado

Na resposta de GET /me, o campo organization informa a organização à qual o token está vinculado, e o campo access informa o que esse token pode ver na organização.

GET /me (resumido)
{
  "data": {
    "token": { "name": "Servidor de monitoramento", "scopes": ["orders:read"] },
    "organization": { "id": "…", "name": "Stax", "slug": "stax" },
    "access": { "order_visibility": "all", "logs": true },
    "plan": { "name": "Tier 2", "custom_credentials": true },
    "billing": { "balance": 124.5, "currency": "USD" }
  }
}
  • access.order_visibility: quais serviços da organização o token pode ver. Os endpoints de lista e de detalhes aplicam a mesma visibilidade do painel.
  • access.logs: se os endpoints de log estão liberados para este token. O acesso a logs também exige que o plano inclua acesso a logs.

Plano e preço

O plano é definido no nível da organização. /me, /catalog e /pricing usam a mesma fonte de plano; por isso, uma cotação de preço e o valor debitado no momento do pedido coincidem. Em uma organização sem plano atribuído, é usado o plano mais baixo, e as respostas mostram price_source: base_plan.

plan.custom_credentials informa se você pode escolher o nome de usuário e a senha no pedido. Sem essa permissão, uma requisição que envie esses campos retorna403 tier_required; se você não os enviar, os valores são gerados automaticamente.

Mais de uma organização

Um usuário pode ser membro de várias organizações; já o token pertence a uma única organização. Crie um token separado para cada organização e, na sua integração, defina a organização escolhendo o token.