Autenticação

Toda requisição leva uma chave de API. A chave define a conta, o workspace e de quem saem os créditos.

Crie uma chaveCopy Anchor Link

Abra Chaves de API e clique em Nova chave. A chave aparece uma vez só: copie e guarde no seu cofre de segredos. Chaves de API estão nos planos Gratuito, Básico, Plus e Pro.

Envie a chaveCopy Anchor Link

Use o header X-Api-Key:

curl https://api.cut.pro/api/v1/workspace \
  -H "X-Api-Key: $CUTPRO_API_KEY"

Ou Authorization: Bearer, se o seu cliente HTTP já monta esse header:

curl https://api.cut.pro/api/v1/workspace \
  -H "Authorization: Bearer $CUTPRO_API_KEY"

Chave ausente, revogada ou vencida responde 401:

{ "code": "UNAUTHORIZED" }

Conta bloqueada responde 403 com ACCOUNT_BLOCKED. Nesse caso nenhuma chave da conta funciona: fale com o suporte.

WorkspacesCopy Anchor Link

Créditos, vídeos, clipes, renders e conexões pertencem a um workspace. A chave é vinculada a um ou mais workspaces, e cada requisição opera em exatamente um.

Chave de um workspaceCopy Anchor Link

Nada a fazer. Toda requisição cai no workspace da chave.

Chave com mais de um workspaceCopy Anchor Link

Mande X-Workspace-Id em toda requisição:

curl https://api.cut.pro/api/v1/balance \
  -H "X-Api-Key: $CUTPRO_API_KEY" \
  -H "X-Workspace-Id: 7401220118845503"

Sem o header, a API responde 400 e lista os workspaces que a chave alcança:

{
  "code": "MISSING_WORKSPACE_ID",
  "extra": { "allowed_workspace_ids": ["7401220118845503", "7401220118845991"] }
}

Um id fora dessa lista responde 400 WORKSPACE_NOT_AUTHORIZED, com a mesma lista em extra.

Para saber em qual workspace a requisição caiu, com plano e papel, chame GET /workspace.

Contas sociaisCopy Anchor Link

Para publicar, o workspace precisa de contas conectadas. GET /connections lista as que existem e devolve o id que vai em connection_id no post. Falta uma rede? GET /connections/link?platform=tiktok devolve um link da Cut.Pro que abre o login daquela rede. Entregue o link para a pessoa, espere ela voltar e liste de novo. Veja Publicação.

Boas práticasCopy Anchor Link

• Uma chave por integração. Se uma vazar, você revoga só ela.
• Revogue o que não usa. A página de chaves mostra cada chave, e revogar vale na hora.
• Não logue o header. Muitos clientes HTTP gravam headers em modo debug.