Documentação API

Esta é a documentação para os endpoints de API disponíveis, que são construídos em torno da arquitetura REST. Todos os endpoints de API retornarão uma resposta JSON com o HTTP padrão códigos de resposta e precisam de uma Autenticação do portador por meio de uma chave API.

 

Autenticação

Todos os endpoints de API requerem uma chave de API enviada pelo método de autenticação do portador.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://biolinks.pt/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

{
    "errors": [
        {
            "title": "Voc\u00ea n\u00e3o tem acesso \u00e0 API.",
            "status": 401
        }
    ]
}
200 Request completed successfully
400 Bad request - Required parameters are missing or invalid
401 Unauthorized - API key is missing or invalid
404 The requested resource was not found
429 Too many requests - Rate limit exceeded
500 Internal server error - this means there is a problem on our end
All API endpoint results work with the UTC timezone unless specified otherwise.
User
Links
Estatísticas de links
Projetos
Pixel
Splash pages
Códigos QR
Leads
Notification handlers
Domínios Personalizados
Pagamentos da Conta
Registros da conta