Skip to main content
O Blob Storage aceita dois tipos de credencial no cabeçalho Authorization:
  • Chave de API: criada nas configurações da sua conta. Funciona em todas as rotas, limitada pelos escopos que você atribuir a ela.
  • Token de upload (squp_...): um token de curta duração que o seu servidor gera com Tokens de Upload. Ele só faz uploads, então é seguro entregá-lo a um navegador.
O uso da API está sujeito aos Termos de Serviço e à Política de Uso Aceitável.
O SDK de Blob (@squarecloud/blob) envia a credencial para você e encapsula todas as rotas desta referência.

​
Escopos

Uma chave de API carrega escopos. O Blob Storage lê dois deles: Uma chave sem o escopo de que a rota precisa recebe 403 MISSING_SCOPE. Uma chave restrita a aplicações específicas não tem acesso ao Blob Storage e recebe 403 RESOURCE_NOT_ALLOWED.
Dê a cada integração a sua própria chave, apenas com o escopo de que ela precisa. Um backend que só serve arquivos precisa de blob:read; um job que só faz uploads precisa de blob:write.

​
Tokens de upload

Um token de upload só é aceito no Envio de Objeto e nas rotas de upload em partes. Qualquer outra rota responde 403 UPLOAD_TOKEN_NOT_ALLOWED. O token fixa o nome, o prefixo, a visibilidade, o tamanho e os tipos de arquivo escolhidos quando foi gerado, e deixa de funcionar quando expira, quando seus usos se esgotam ou quando a chave de API que o gerou é revogada.

​
Gateway S3

Ferramentas S3 não enviam a chave de API em si. Elas assinam as requisições (SigV4) com um par de chaves de acesso derivado dela: obtenha-o em Credenciais S3 e leia Compatibilidade com S3.

​
Erros

As respostas de erro seguem o formato { "status": "error", "code": "SOME_CODE" }, às vezes com uma message que explica o caso. Use code na sua lógica, nunca message. A lista completa está em Erros.

​
Erros globais

Qualquer rota do Blob também pode retornar estes:

Limites e Restrições

Conheça os limites e restrições da API da Square Cloud.