Transferências
Guias relacionados: Enviar arquivos, Receber arquivos e Links compartilhados.
POST /upload
Recebe um arquivo do usuário autenticado.
Acesso: sessão (token Bearer ou cookie).
Corpo: multipart/form-data ou application/octet-stream.
Campos do multipart/form-data:
| Campo | Obrigatório | Descrição |
|---|---|---|
file | Sim | Conteúdo do arquivo. |
d | Não | Destinatário ou usuário de destino. |
m | Não | E-mail associado à transferência. |
c | Não | Celular associado à transferência. |
h | Não | Hash SHA-256 esperado do arquivo. |
n | Não | Identificação ou e-mail do remetente. |
i | Não | Informação adicional ou tags da transferência. |
Headers do application/octet-stream (arquivo no corpo bruto):
| Header | Obrigatório | Equivale a |
|---|---|---|
X-STCPDIRECTLINK-FILENAME | Sim | Nome do arquivo |
X-STCPDIRECTLINK-DESTINATION | Não | d |
X-STCPDIRECTLINK-EMAIL | Não | m |
X-STCPDIRECTLINK-MOBILE | Não | c |
X-STCPDIRECTLINK-HASH | Não | h |
X-STCPDIRECTLINK-EMAIL-FROM | Não | n |
X-STCPDIRECTLINK-INFO | Não | i |
Respostas
| HTTP | Significado | Corpo |
|---|---|---|
200 | Arquivo recebido. | UploadResponse |
400 | Requisição ou parâmetro inválido. | — |
401 | Credencial não aceita. | — |
403 | Operação não permitida pelas regras do usuário ou do ambiente. | — |
POST /directlink/v2/upload HTTP/1.1
Host: api.exemplo.com
Authorization: Bearer <access_token>
Content-Type: application/octet-stream
X-STCPDIRECTLINK-FILENAME: documento.pdf
X-STCPDIRECTLINK-DESTINATION: <destino>
<bytes-do-arquivo>GET /download/list e /download/list/backup
Listam os arquivos disponíveis para o usuário na área principal (/download/list) ou na área de backup (/download/list/backup).
Acesso: sessão (token Bearer ou cookie).
| Parâmetro | Local | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
page | query | Não | 0 | Página de resultados. Valores ausentes ou inválidos são tratados como 0. |
Respostas
| HTTP | Significado | Corpo |
|---|---|---|
200 | Lista de arquivos. | FileListResponse |
401 | Credencial não aceita. | — |
A listagem principal devolve links para /download/file; a de backup, para /download/file/backup.
GET /download/file e /download/file/backup
Baixam um arquivo listado. São chamados pelo linkURL da listagem.
Acesso: link seguro e token Bearer (no header Authorization ou no cookie de sessão) do mesmo usuário que fez a listagem. O link sozinho não dá acesso ao arquivo.
Respostas
| HTTP | Significado | Corpo |
|---|---|---|
200 | Conteúdo do arquivo. | application/octet-stream |
400 | Credencial ausente. | — |
401 | Token inválido ou expirado. | — |
403 | O token é de outro usuário, o download está desabilitado ou o acesso foi bloqueado. | — |
404 | Arquivo ou link não encontrado. | — |
Headers da resposta
| Header | Descrição |
|---|---|
Content-Type | Tipo MIME deduzido da extensão do arquivo; application/octet-stream quando desconhecido. |
Content-Disposition | attachment; filename="<nome-do-arquivo>". |
Content-Length | Tamanho do arquivo, em bytes. |
X-STCPDIRECTLINK-HASH | Hash SHA-256 informado no upload do arquivo (vazio quando não foi informado). |
GET /download
Entrega um arquivo a partir de um link seguro compartilhado.
Acesso: link seguro.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
p | query | Quando o link exigir | PIN do download. Os demais parâmetros vêm no link e não devem ser alterados. |
Respostas
| HTTP | Significado | Corpo |
|---|---|---|
200 | Conteúdo do arquivo. | application/octet-stream |
404 | Arquivo ou link não encontrado. | — |
Os headers da resposta são os mesmos de /download/file.
GET /download/pin
Gera um PIN, envia-o ao destinatário configurado e devolve o link para continuar em /download.
Acesso: link seguro emitido pelo serviço para iniciar o envio do PIN.
Respostas
| HTTP | Significado | Corpo |
|---|---|---|
200 | PIN enviado; a resposta contém o link de download. | DownloadPinResponse |