Documentação da API

Esta é a documentação dos pontos finais da API disponíveis, que são construídos em torno da arquitetura REST. Todos os pontos finais da API retornarão uma resposta JSON com os códigos de resposta HTTP padrão e precisam de uma autenticação Bearer via chave de API.

Get your own API Key

URL base.

Autenticação

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

Authorization: Bearer {api_key}

Exemplo

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

Errors

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

Exemplo

{
    "errors": [
        {
            "title": "Voc\u00ea n\u00e3o tem acesso \u00e0 API.",
            "status": 401
        }
    ]
}

Status codes

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.

Usuário

Links

Estatísticas de links

Pixels

Páginas de introdução

QR codes: códigos QR

Assinaturas

Data

Notification handlers

Domínios personalizados

Registros da conta.