Saltar para o conteúdo

Início rápido

Este roteiro leva você da primeira chamada até o envio e o download de um arquivo, usando um token OAuth obtido com usuário e senha.

Importante

Use um usuário de teste. Não reutilize credenciais de produção em ambientes de teste.

Pré-requisitos:

  • host do Riversoft® STCP DirectLink do seu ambiente, informado pelo administrador do serviço;
  • usuário e senha com permissão de upload e download;
  • curl instalado.

Defina a URL base

export API_BASE='https://api.exemplo.com/directlink/v2'

Substitua api.exemplo.com pelo host do seu ambiente.

Verifique a disponibilidade

curl -i "$API_BASE/healthcheck"

A resposta 200 indica que a API está acessível:

{
  "status": "ok",
  "service": "STCPDirectLink",
  "timestamp": "2026-10-16T19:29:23Z",
  "uptime_seconds": 86400
}

Obtenha um token de acesso

read -r -p 'Usuário: ' API_USER
read -r -s -p 'Senha: ' API_PASSWORD; printf '\n'

curl -s \
  --data-urlencode 'grant_type=password' \
  --data-urlencode "username=$API_USER" \
  --data-urlencode "password=$API_PASSWORD" \
  "$API_BASE/oauth2/token"

Copie o valor de access_token da resposta para uma variável:

export ACCESS_TOKEN='<access_token recebido>'

Envie um arquivo

curl -i \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -F 'file=@./documento.pdf' \
  "$API_BASE/upload"

A resposta 200 traz os dados da transferência, como id, destination e length.

Liste os arquivos disponíveis

curl -s \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  "$API_BASE/download/list"

Cada item de files tem um linkURL, o link assinado para baixar aquele arquivo.

Baixe um arquivo

export FILE_URL='<linkURL do arquivo escolhido>'
curl -L --fail --output ./documento-baixado.pdf "$FILE_URL"

Encerre a sessão

curl -i -X POST \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  "$API_BASE/auth/logout"

Resultado esperado: o arquivo enviado aparece no destino configurado para o usuário e o arquivo escolhido na listagem é salvo em ./documento-baixado.pdf.

Nota

As operações dependem das regras configuradas para o usuário. Se alguma etapa retornar 403, veja Regras de acesso e Solução de problemas.

Próximos passos