Modelos de dados
Os modelos correspondem aos schemas da especificação OpenAPI. Campos não listados podem aparecer conforme o ambiente; ignore campos que a sua integração não conhece.
OperationResponse
Envelope comum das respostas de operação.
| Campo | Tipo | Descrição |
|---|---|---|
status | integer | Resultado da operação. 0 indica sucesso. |
description | string | Descrição do resultado retornada pela API. |
apiver | string | Versão da API e do produto, no formato v2 (9.0.1). |
user | string | Usuário da operação. |
length | integer (int64) | Tamanho, em bytes, quando aplicável. |
time | string | Data e hora da resposta no formato ISO 8601 (RFC 3339), com o fuso horário do servidor, por exemplo 2026-11-07T14:03:21-03:00. Na API v1, o campo usava o formato 2026-11-07 14:03:21.123456789 -0300 -03. |
LoginResponse
Resposta 200 de /auth/login.
| Campo | Tipo | Descrição |
|---|---|---|
status | integer | 0 em caso de sucesso. |
description | string | Descrição do resultado. |
apiver | string | Versão da API e do produto, no formato v2 (9.0.1). |
user | string | Usuário autenticado. |
urllink | string (URI) | Link de acesso ao portal. |
time | string | Data e hora da resposta no formato ISO 8601 (RFC 3339), com o fuso horário do servidor, por exemplo 2026-11-07T14:03:21-03:00. Na API v1, o campo usava o formato 2026-11-07 14:03:21.123456789 -0300 -03. |
O token de sessão não faz parte do JSON; ele é enviado no cookie __Host-dirl_session.
MfaChallengeResponse
Resposta 206 de /auth/login quando o MFA é exigido.
| Campo | Tipo | Descrição |
|---|---|---|
status | integer | Etapa do MFA: 1 PIN por e-mail ou SMS, 2 TOTP cadastrado, 3 cadastro do TOTP. |
description | string | Descrição do desafio. |
apiver | string | Versão da API e do produto, no formato v2 (9.0.1). |
user | string | Usuário. |
linkURL | string (URI) | URL segura integral: /auth/mfa (status 1 e 2) ou /auth/mfa/register (status 3). |
secret | string | Status 3: segredo TOTP em Base32. Vazio no status 2; ausente no status 1. Dado sensível. |
qrcode | string | Status 3: QR code do segredo, imagem PNG de 200 × 200 em Base64 URL-safe. Vazio no status 2; ausente no status 1. |
time | string | Data e hora da resposta no formato ISO 8601 (RFC 3339), com o fuso horário do servidor, por exemplo 2026-11-07T14:03:21-03:00. Na API v1, o campo usava o formato 2026-11-07 14:03:21.123456789 -0300 -03. |
MfaRegisterResponse
Resposta 200 de /auth/mfa/register. Não estabelece sessão.
| Campo | Tipo | Descrição |
|---|---|---|
status | integer | 0 em caso de sucesso. |
description | string | Descrição do resultado. |
apiver | string | Versão da API e do produto, no formato v2 (9.0.1). |
user | string | Usuário. |
length | integer | Sempre 0. |
time | string | Data e hora da resposta. |
SecureLinkResponse
Resposta de /auth/firstaccess e /auth/forget.
| Campo | Tipo | Descrição |
|---|---|---|
status | integer | 0 em caso de sucesso. |
description | string | Descrição do resultado. |
apiver | string | Versão da API e do produto, no formato v2 (9.0.1). |
user | string | Usuário. |
linkURL | string (URI) | Link seguro enviado ao usuário. |
time | string | Data e hora da resposta no formato ISO 8601 (RFC 3339), com o fuso horário do servidor, por exemplo 2026-11-07T14:03:21-03:00. Na API v1, o campo usava o formato 2026-11-07 14:03:21.123456789 -0300 -03. |
TokenResponse
Resposta 200 de /auth/token e /oauth2/token. Todos os campos são sempre retornados.
| Campo | Tipo | Descrição |
|---|---|---|
access_token | string | Token de acesso. |
issued_token_type | string | urn:ietf:params:oauth:token-type:access_token. |
token_type | string | Bearer. |
expires_in | integer (int64) | Validade do token, em segundos. Varia conforme o ambiente. |
scope | string | URI da API configurada. Não representa uma lista de permissões. |
OAuthError
Resposta 400 de /auth/token e /oauth2/token.
| Campo | Tipo | Descrição |
|---|---|---|
error | integer | Código numérico da condição reportada pela validação. |
error_description | string | Motivo da falha. |
error_uri | string (URI) | URI da API. |
UploadResponse
Resposta 200 de /upload. Inclui os campos de OperationResponse e:
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Nome ou identificador do arquivo recebido. |
destination | string | Destino da transferência. |
length | integer (int64) | Tamanho recebido, em bytes. |
linkURL | array de string (URI) | Links de notificação gerados, quando houver. |
FileListResponse
Resposta 200 de /download/list e /download/list/backup. Inclui os campos de OperationResponse e:
| Campo | Tipo | Descrição |
|---|---|---|
files | array de FileEntry | Arquivos da página. Pode vir vazio. |
page_next | string | Índice da página seguinte. |
FileEntry
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | Identificador do arquivo na listagem. |
name | string | Nome do arquivo. |
length | integer (int64) | Tamanho, em bytes. |
modified | integer (int64) | Data de modificação, em milissegundos desde 1970-01-01 UTC. |
linkURL | string (URI) | Link assinado para download. Use a URL integral. |
DownloadPinResponse
Resposta 200 de /download/pin. Inclui os campos de OperationResponse e:
| Campo | Tipo | Descrição |
|---|---|---|
email | string | E-mail do destinatário. |
phone | string | Telefone do destinatário. |
file | string | Nome do arquivo. |
linkURL | string (URI) | Link seguro para o download. |
ReportResponse
Resposta 200 de /report. Inclui os campos de OperationResponse e:
| Campo | Tipo | Descrição |
|---|---|---|
page | integer | Página retornada. |
logs | array de objetos | Registros de transferência da consulta. |