API REST
O Riversoft® STCP DirectLink oferece uma API REST para que aplicações enviem e recebam arquivos sem intervenção manual, com os mesmos controles do Riversoft STCP DirectLink Portal: autenticação, áreas de download e backup, links seguros e rastreabilidade.
A documentação completa da API (conceitos, autenticação, guias, referência de endpoints e especificação OpenAPI) fica na seção própria Riversoft STCP DirectLink API.
Quando usar a API
| Cenário | Exemplo |
|---|---|
| Integração entre sistemas | Um ERP envia notas fiscais e recebe retornos automaticamente. |
| Distribuição para destinatários externos | Uma aplicação envia o arquivo e o destinatário recebe um link seguro por e-mail, SMS ou WhatsApp. |
| Portais de serviços | Um portal de terceiros autentica o usuário por SSO ou token JWT de confiança e o direciona ao Riversoft STCP DirectLink. |
| Auditoria | Um sistema de monitoramento consulta o relatório de transferências. |
Primeiros passos
| Item | Valor |
|---|---|
| URL base | https://<dominio>/directlink/v2 |
| Transporte | HTTPS |
| Formato das respostas | JSON (conteúdo binário nos downloads) |
| Versão da API | v2, informada no caminho e no campo apiver das respostas |
| Especificação | OpenAPI 3.0.3, em português, inglês e espanhol |
Documentação da API
| Para | Consulte |
|---|---|
| Fazer as primeiras chamadas | Início rápido |
| Escolher o método de autenticação (Basic, OAuth 2.0, JWT, SSO, MFA) | Autenticação |
| Enviar, receber e compartilhar arquivos | Guias |
| Consultar endpoints, modelos de dados e códigos | Referência da API |
| Baixar o arquivo OpenAPI | Especificação OpenAPI |
Autenticação na versão 9
As rotas protegidas da API (upload, listagens, relatório e logout) exigem token Bearer. A autenticação Basic é aceita somente no login. Veja Segurança › Autenticação na API.
Coleção Postman
Para simplificar o desenvolvimento e os testes, use a coleção Postman com as chamadas da API. Ela já grava o token obtido na variável token, usada nas demais requisições.