Documentação da API

Saiba como conectar e integrar com nossa API.

Obtenha sua própria chave de API

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://transf.com.br/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Nossa API usa códigos de status HTTP convencionais para indicar o sucesso ou falha de uma solicitação.

Exemplo

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

Códigos de status

200 Solicitação concluída com sucesso

400 Solicitação inválida - Parâmetros obrigatórios estão ausentes ou inválidos

401 Não autorizado - Chave da API está ausente ou é inválida

404 O recurso solicitado não foi encontrado

429 Muitas solicitações - Limite de taxa excedido

500 Erro interno do servidor - isso significa que há um problema do nosso lado

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

Usuário

Arquivos

Transferências

Estatísticas de transferências

Transferir estatísticas de downloads

Manipuladores de notificações

Equipes

Membros da equipe

Membro da equipe

Pagamentos da conta

Registros de conta