Skip to Content
Referência da APIAccountOverview

API de Conta

A API de Conta expõe detalhes somente leitura sobre a conta vinculada à sua chave de API: seu perfil, plano e saldo de créditos. É uma boa primeira chamada ao configurar uma integração: confirme que a chave resolve para a conta esperada e verifique os créditos antes de iniciar um trabalho que os consome.

Convenções

As requisições usam a URL base https://api.vdclip.com com o cabeçalho Authorization: Bearer vdck_.... A API é exclusivamente servidor-a-servidor e não tem CORS.

Respostas bem-sucedidas retornam o recurso diretamente. Erros retornam um array errors. Ambos os endpoints exigem o escopo vdclip:account:read; um escopo ausente retorna MISSING_SCOPE.

i
Créditos controlam as operações que têm custo

Operações que custam créditos, como renderizar ou publicar, retornam INSUFFICIENT_CREDITS quando seu saldo está muito baixo. Verifique GET /v1/credits primeiro para que sua integração possa pausar ou alertar em vez de falhar. Consulte a página de preços para os níveis de plano e as cotas de créditos.

Endpoints

👤

Obter perfil da conta e plano

GET /v1/account

VerConfirme o perfil e o plano vinculados à sua chave de API
💳

Obter saldo de créditos

GET /v1/credits

VerVerifique os créditos disponíveis antes de executar operações pagas
Última atualização em