Documentação de API

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

Get your own API Key

Base URL

Authentication

All the API requests require authentication through an API key sent via the Authorization header as shown below.

Authorization: Bearer {api_key}

Example

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

Errors

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

Example

{
    "errors": [
        {
            "title": "You do not have access to the 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.

User

Links

Links statistics

Projetos

Pixels

QR Codes

Contatos

Notification handlers

Domínios personalizados

Minhas equipes

Team members

Teams' member

Registros de conta