Referência
Referência da API
Esta seção é a fonte de consulta do contrato da API. Para exemplos passo a passo, veja os Guias e Autenticação.
Convenções
| Item | Valor |
|---|---|
| URL base | https://{host}/directlink/v2 |
| Credencial nas rotas protegidas | Authorization: Bearer <access_token> ou cookie __Host-dirl_session (o header prevalece) |
| Corpo das requisições | application/x-www-form-urlencoded, multipart/form-data ou application/octet-stream |
| Corpo das respostas | application/json; conteúdo binário nos downloads; XML nos metadados SAML |
Tipos de acesso
| Acesso | Significado |
|---|---|
| Público | Não exige credencial. |
| HTTP Basic | Usuário e senha no header Authorization: Basic. |
| Sessão | Token Bearer ou cookie de sessão. |
| Link seguro | URL assinada emitida pela API; os parâmetros do link autorizam a operação. |
| Provedor | Chamada feita pelo provedor de identidade durante o fluxo SSO. |
Catálogo de endpoints
| Método | Caminho | Acesso | Descrição |
|---|---|---|---|
GET | /healthcheck | Público | Verifica a disponibilidade. |
GET, POST | /auth/login | HTTP Basic | Inicia a sessão local; pode exigir MFA. |
GET, POST | /auth/mfa | Link seguro | Valida o segundo fator. |
GET, POST | /auth/mfa/register | Link seguro | Confirma o cadastro do autenticador TOTP. |
POST | /auth/token | Público (formulário OAuth) | Emite token por password grant ou token exchange. |
POST | /oauth2/token | Público (formulário OAuth) | Equivalente a /auth/token. |
GET | /auth/firstaccess | Público | Inicia o primeiro acesso. |
GET | /auth/forget | Público | Inicia a recuperação de senha. |
POST | /auth/change | Link seguro | Conclui o primeiro acesso ou a troca de senha. |
GET, POST | /auth/logout | Sessão | Encerra a sessão. |
GET | /sso/login | Público | Inicia o login federado. |
GET | /sso/logout | Sessão | Inicia o logout federado. |
GET, POST | /sso/oauth2/cb | Provedor | Callback OAuth 2.0 e 2.1/OpenID Connect. |
GET, POST | /sso/oauth2/logout/cb | Provedor | Callback de logout OAuth 2.0. |
POST | /sso/saml2/acs | Provedor | Recebe a asserção SAML 2.0. |
GET, POST | /sso/saml2/slo | Provedor | Recebe a mensagem de logout SAML 2.0. |
GET | /sso/saml2/metadata | Público | Metadados SAML 2.0 do provedor. |
GET | /sso/saml2/metadata/{provider} | Público | Metadados SAML 2.0 do provedor. |
POST | /upload | Sessão | Envia um arquivo. |
GET | /download/list | Sessão | Lista os arquivos disponíveis. |
GET | /download/list/backup | Sessão | Lista os arquivos da área de backup. |
GET | /download/file | Link seguro e token | Baixa um arquivo listado. |
GET | /download/file/backup | Link seguro e token | Baixa um arquivo da área de backup. |
GET | /download | Link seguro | Entrega um arquivo compartilhado. |
GET | /download/pin | Link seguro | Envia o PIN e devolve o link de download. |
GET | /report | Sessão | Consulta os registros de transferência. |
Nota
Quando o Cloudflare Turnstile está habilitado no ambiente, /auth/login, /auth/firstaccess e /auth/forget exigem o header CF-Turnstile-Response. Veja Cloudflare Turnstile.
Nesta seção
Contrato OpenAPI 3.0.3 da API em português, inglês e espanhol, com visualização interativa.
Endpoint de verificação de disponibilidade da API.
Endpoints de login, MFA, emissão de token, primeiro acesso, senha e logout.
Endpoints de login, logout, callbacks e metadados para OAuth 2.0 e 2.1/OpenID Connect e SAML 2.0.
Endpoints de upload, listagem, download de arquivos e links compartilhados.
Endpoint de consulta dos registros de transferência.
Estrutura dos objetos JSON devolvidos pela API.
Status HTTP, erros de emissão de token e eventos de sessão e transferência.