Credenciais S3 Blob

GET

credentials

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/s3/credentials' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "access_key_id": "SQ2_3155597145698959364_k7Hq2mX9",
    "secret_access_key": "vR8nLq2Wz5Tc1Yb7Hs0Kd4Jf6Gm3Pa9Xe",
    "endpoint": "https://s3-blob.squarecloud.app",
    "region": "auto",
    "buckets": ["public", "private", "legacy"],
    "access": { "read": true, "write": true },
    "expires_at": null
  }
}

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

O Credenciais S3 retorna o par de chaves de acesso que as ferramentas S3 usam para assinar as requisições ao gateway S3. O par é derivado da chave de API que chama esta rota: chamar de novo retorna o mesmo par, e revogar, regenerar ou deixar a chave expirar faz o mesmo com o par. Não há mais nada para rotacionar ou revogar. Chame-a com uma chave de API que tenha blob:read ou blob:write. O par pode ler com blob:read e gravar com blob:write, como mostra o campo access.

A secret_access_key dá o mesmo acesso que a chave de API. Guarde-a como a própria chave.

O par não muda enquanto a chave de API não mudar. Busque-o uma vez e guarde-o no seu gerenciador de segredos ou em uma variável de ambiente: não chame esta rota toda vez que a sua aplicação iniciar.

Limites de taxa

10 requisições por hora por conta (RATE_LIMITED, 429).

Resposta

string

“success” se bem-sucedida, “error” caso contrário.

object

Mostrar Alternar objeto

string

O id da chave de acesso (SQ2_...).

string

A chave de acesso secreta.

string

https://s3-blob.squarecloud.app

string

auto

string[]

Os buckets da sua conta: public, private e legacy.

object

read e write, cada um true ou false, conforme os escopos da chave.

ISO 8601 | null

Quando a chave de API, e portanto o par, expira. null quando não expira.

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/s3/credentials' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "access_key_id": "SQ2_3155597145698959364_k7Hq2mX9",
    "secret_access_key": "vR8nLq2Wz5Tc1Yb7Hs0Kd4Jf6Gm3Pa9Xe",
    "endpoint": "https://s3-blob.squarecloud.app",
    "region": "auto",
    "buckets": ["public", "private", "legacy"],
    "access": { "read": true, "write": true },
    "expires_at": null
  }
}

Erros

Código	HTTP	Quando
`API_KEY_REQUIRED`	400	Chamada com uma sessão do dashboard. Use uma chave de API.
`LEGACY_API_KEY`	400	A chave usa um formato antigo que não consegue assinar requisições S3. Crie uma nova chave de API.
`INVALID_CREDENTIAL`	401	A chave de API não pôde ser verificada.
`MISSING_SCOPE`	403	A chave não tem `blob:read` nem `blob:write`.
`RATE_LIMITED`	429	Mais de 10 requisições em uma hora.

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/s3/credentials' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "access_key_id": "SQ2_3155597145698959364_k7Hq2mX9",
    "secret_access_key": "vR8nLq2Wz5Tc1Yb7Hs0Kd4Jf6Gm3Pa9Xe",
    "endpoint": "https://s3-blob.squarecloud.app",
    "region": "auto",
    "buckets": ["public", "private", "legacy"],
    "access": { "read": true, "write": true },
    "expires_at": null
  }
}

Primeiros Passos

Objetos

Uploads em Partes

Conta

Links de Compartilhamento

S3

Limites de taxa

Resposta

Erros

​Limites de taxa

​Resposta

​Erros

Limites de taxa

Resposta

Erros