For the complete documentation index, see llms.txt. This page is also available as Markdown.

Cabeçalhos HTTP

Esta secção descreve os cabeçalhos HTTP que a API aceitará de qualquer pedido.

Content-Type

Todos os pedidos devem conter um cabeçalho HTTP content-type.

Tipos de conteúdo aceites

Formato base
Tipos de conteúdo
Tipos de conteúdo

JSON

application/json

text/json não é atualmente um tipo de conteúdo aceite

Dados de formulário

multipart/form-data

Usado apenas ao carregar variações

Erros de Content-Type

Código da resposta
Notas

400

O tipo de conteúdo foi compreendido, mas não pôde ser descodificado. Mais informações aparecerão no corpo da resposta

415

O tipo de conteúdo está em falta ou não é suportado

Nota: Nos casos em que o cabeçalho content-type tenha um problema, o content-type da resposta será o formato predefinido da API, atualmente application/json

Nota: A API atualmente não segue o cabeçalho HTTP Accept-type; todas as respostas são enviadas no mesmo content-type do pedido recebido, desde que o content-type do pedido seja válido

Autorização

Este cabeçalho é opcional e é usado para fornecer detalhes de autenticação à API para o utilizador atual, o que permitirá ao utilizador atual aceder a recursos restritos da API. Os tokens podem ser obtidos através da API de Login. Um exemplo de cabeçalho é:

Authorization: Bearer 45267dbe480c8c7d799c62ccad92cb44f67ab086

O cabeçalho Authorization aceita uma cadeia de caracteres construída a partir de duas partes, separadas por um único espaço. A primeira parte é o tipo de token, a segunda é o próprio token de acesso.

Erros de autorização

Código da resposta
Notas

400

Foi fornecido um cabeçalho de autorização malformado

401

O cabeçalho de autorização está em falta ou o token era inválido ou expirou

Escolher um tipo de token de autorização

Em qualquer falha, os cabeçalhos da resposta conterão um cabeçalho WWW-Authenticate, que indicará o tipo de token necessário para o acesso.

Última atualização

Isto foi útil?