CreateYourVPN Academy
API de parceiros

API de parceiros

API de servidor para parceiros: crie clientes, atribua planos e gerencie assinaturas no seu site ou bot.

A API de parceiros permite criar seu próprio site, painel do cliente ou bot sobre o CreateYourVPN. Ela expõe apenas clientes, planos e assinaturas; servidores, nós, painéis e credenciais de infraestrutura nunca aparecem nas respostas.

A chave é exclusiva para comunicação servidor a servidor. Nunca a coloque em JavaScript ou em um aplicativo móvel. Solicitações que parecem vir de um navegador são recusadas com 403 browser_forbidden.

Primeiros passos

  1. Abra Configurações → API e integrações no painel.
  2. Crie uma chave com as permissões mínimas e copie o segredo; ele é exibido uma única vez.
  3. Envie-a como Authorization: Bearer cyv_live_… ou X-API-Key.
curl https://api.createyourvpn.com/api/v1/partner-api/me \
  -H "Authorization: Bearer cyv_live_<key_id>_<secret>"

Permissões disponíveis: config:read para configuração e locais, users:read para consultar clientes e users:write para criar clientes e gerenciar suas assinaturas.

Contrato público

A coleção pública do Postman contém todos os endpoints, parâmetros, corpos, exemplos, permissões e códigos de erro. Ela é gerada a partir do contrato do backend e é a única referência técnica.

Limites: 120 solicitações por minuto por chave e 10 por minuto para GET /users. grant, rotate e DELETE exigem Idempotency-Key; reutilize o mesmo valor por 24 horas em todas as tentativas do mesmo evento.

On this page