HTTP Headers
Esta secção descreve os cabeçalhos HTTP que a API aceitará em qualquer pedido.
Tipo de conteúdo
Todos os pedidos devem conter um cabeçalho HTTP do tipo content-type.
Tipos de conteúdo aceites
| Formato de base | Tipos de conteúdo | Tipos de conteúdo |
|---|---|---|
| JSON | aplicação/json | text/json não é atualmente um tipo de conteúdo aceite |
| Dados do formulário | multipart/form-data | Utilizado apenas para carregar variações |
Erros de tipo de conteúdo
| Código de resposta | Notas |
|---|---|
| 400 | O tipo de conteúdo foi compreendido mas não pôde ser descodificado. Serão apresentadas mais informações 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 tem um problema, o content-type da resposta será o formato predefinido para a API, atualmente application/json
Nota: A API atualmente não adere ao cabeçalho HTTP Accept-type, todas as respostas são enviadas no mesmo tipo de conteúdo que o pedido recebido, desde que o tipo de conteúdo do pedido seja válido
Autorização
Este cabeçalho é opcional e é utilizado 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 início de sessão. Um exemplo de cabeçalho é:
Authorization: Bearer 45267dbe480c8c7d799c62ccad92cb44f67ab086
O cabeçalho Authorization aceita uma cadeia de caracteres que é 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 de 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 |
Seleção de um tipo de token de autorização
Em caso de falha, os cabeçalhos de resposta conterão um cabeçalho WWW-Authenticate que indicará o tipo de token necessário para o acesso.