DocsAutenticação
Saiba como autenticar-se com a API da Cost+
Toda a comunicação com a API da Cost+ requer TLS 1.2 ou superior e Autenticação Básica HTTP.
Como Funciona a Autenticação Básica
Autentique-se utilizando a sua chave API como nome de utilizador com uma palavra-passe vazia. Codifique em Base64 a string \{api_key\}: (note os dois pontos no final — a palavra-passe está vazia).
O cabeçalho Authorization resultante tem este aspeto:
Authorization: Basic aHVudGVyMjo=Nunca exponha a sua chave API em código do lado do cliente ou em repositórios públicos. Mantenha-a apenas no lado do servidor.
Utilizar cURL
Integrado (recomendado)
O cURL suporta nativamente Autenticação Básica com a flag -u. Passe a sua chave API seguida de dois pontos:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Codificação manual em Base64
Se preferir construir o cabeçalho manualmente, primeiro codifique a chave:
echo -n "YOUR_API_KEY:" | base64Em seguida, passe o valor codificado no cabeçalho Authorization:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Os dois pontos após a chave API são obrigatórios — separam o nome de utilizador da palavra-passe (vazia) no esquema de Autenticação Básica.
Códigos de Estado HTTP
A API utiliza códigos de estado HTTP padrão para indicar o resultado de um pedido.
| Código de Estado | Significado | Descrição |
|---|---|---|
| 200 | OK | Pedido bem-sucedido. |
| 201 | Criado | Recurso criado com sucesso. |
| 400 | Pedido Inválido | O pedido estava malformado ou com campos obrigatórios em falta. |
| 401 | Não Autorizado | Autenticação falhou — verifique a sua chave API. |
| 403 | Proibido | Não tem permissão para aceder a este recurso. |
| 404 | Não Encontrado | O recurso solicitado não existe. |
| 500 | Erro Interno do Servidor | Algo correu mal do nosso lado. |
| 502 | Bad Gateway | Erro no serviço upstream. |
| 503 | Serviço Indisponível | A API está temporariamente indisponível. |
| 504 | Gateway Timeout | O serviço upstream não respondeu a tempo. |