Documentação da 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 os códigos de resposta HTTP padrão e precisarão de uma Autenticação de Portador por meio de uma Chave de API.

Get your own API Key

URL base

Autenticação

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

Authorization: Bearer {api_key}

Exemplo

curl --request GET \
--url 'https://mycodes.com.br/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

Todos os resultados do endpoint da API funcionam com o fuso horário UTC, a menos que especificado de outra forma.

Usuário

Código QR

Códigos de barras

Links

Estatísticas de links

Projetos

Pixels

Domínios personalizados

Registros de conta