Skip to Content
Referência da APITemplatesOverview

API de Templates

A API de Templates gerencia templates reutilizáveis de legendas e layout. Um template captura as escolhas de estilo e layout que você deseja reutilizar, permitindo referenciá-lo por id ao criar um projeto em vez de reespecificar as mesmas configurações toda vez. Use estes endpoints para listar, criar, buscar, atualizar e excluir templates.

i
Apenas servidor para servidor

Todas as requisições /v1 usam a URL base https://api.vdclip.com  com o cabeçalho Authorization: Bearer vdck_…. A API é apenas servidor para servidor e não tem CORS. Ler e listar templates requer o escopo vdclip:templates:read; criar, atualizar e excluir requerem vdclip:templates:write. Um escopo ausente retorna missing_scope.

Convenções

Respostas bem-sucedidas retornam o recurso diretamente, sem envelope. Os erros retornam { "errors": [{ "code", "description", <location>? }] }; códigos comuns aqui são invalid_api_key (401), missing_scope (403), validation_error (422), not_found (404) e rate_limited (HTTP 429 com um cabeçalho Retry-After).

Os resultados de listagem paginam com o parâmetro de consulta cursor (máx. 100) e retornam { "items": [...], "next_cursor": "<opaque>" | null }. Ao criar um projeto, passe um id de template existente em vez de reenviar a mesma configuração de legenda e layout.

Endpoints

📋

Listar templates

GET /v1/templates

VerNavegue pelos templates disponíveis na sua conta

Criar um template

POST /v1/templates

VerSalve um novo template reutilizável de legenda ou layout
🔎

Obter um template

GET /v1/templates/{template_id}

VerBusque um único template pelo seu id
✏️

Atualizar um template

PATCH /v1/templates/{template_id}

VerAltere o nome de um template ou sua configuração
🗑️

Excluir um template

DELETE /v1/templates/{template_id}

VerRemova um template que você não precisa mais
Última atualização em