Settings API

Sending, storage, logo

How the company’s mail leaves — Yet’s Amazon SES or its own — the bucket Drive keeps its files in, and its logo.

URL base https://acme.yet.com.br/api/settings

Settings respondem no endereço da sua empresa — acme aqui — e aceitam a key de quem administra o Settings.

As descrições dos endpoints estão em inglês.

Get sending

GET/api/settings/sending

Which SES the mail leaves through, and whether Yet’s is open to the company.

Quem: Runs the company’s Settings

Requisição

curl https://acme.yet.com.br/api/settings/sending \
  -H "Authorization: Bearer $YET_API_KEY"

Resposta · 200

{
  "sending": "yet",
  "ses_allowed": true
}

Set sending

PUT/api/settings/sending

yet, Yet’s SES; or own, the company’s, through its AWS account.

Quem: Runs the company’s Settings

Corpo

sending"yet" | "own"obrigatório: Which SES.

Requisição

curl -X PUT https://acme.yet.com.br/api/settings/sending \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "sending": "own"
  }'

Get Drive’s bucket

GET/api/settings/storage

Its bucket and folder, or null while Drive keeps the files itself.

Quem: Runs the company’s Settings

Requisição

curl https://acme.yet.com.br/api/settings/storage \
  -H "Authorization: Bearer $YET_API_KEY"

Resposta · 200

{
  "storage": {
    "bucket": "acme-drive",
    "prefix": "files"
  }
}

Set Drive’s bucket

PUT/api/settings/storage

In the company’s AWS account; written to once, to be sure it works.

Quem: Runs the company’s Settings

Corpo

bucketstringobrigatório: The bucket.
prefixstring: A folder in it.

Requisição

curl -X PUT https://acme.yet.com.br/api/settings/storage \
  -H "Authorization: Bearer $YET_API_KEY"

Remove Drive’s bucket

DELETE/api/settings/storage

Its files stay in it.

Quem: Runs the company’s Settings

Requisição

curl -X DELETE https://acme.yet.com.br/api/settings/storage \
  -H "Authorization: Bearer $YET_API_KEY"

Get the logo

GET/api/settings/logo

Its type and bytes, in base64 — or null, Yet’s mark.

Quem: Runs the company’s Settings

Requisição

curl https://acme.yet.com.br/api/settings/logo \
  -H "Authorization: Bearer $YET_API_KEY"

Resposta · 200

{
  "logo": {
    "content_type": "image/png",
    "data": "iVBORw0KGgo…"
  }
}

Set the logo

PUT/api/settings/logo

Shown on the sign-in page: PNG, JPEG, WebP, GIF or SVG, up to 256 KB.

Quem: Runs the company’s Settings

Corpo

content_typestringobrigatório: Its type.
datastringobrigatório: Its bytes, in base64.

Requisição

curl -X PUT https://acme.yet.com.br/api/settings/logo \
  -H "Authorization: Bearer $YET_API_KEY"

Remove the logo

DELETE/api/settings/logo

Back to Yet’s mark.

Quem: Runs the company’s Settings

Requisição

curl -X DELETE https://acme.yet.com.br/api/settings/logo \
  -H "Authorization: Bearer $YET_API_KEY"