Riversoft STCP Gemini API

Versão 3.10.0

A Riversoft STCP Gemini API é a API REST de gestão do Riversoft® STCP Gemini e do Riversoft STCP DirectLink. É a mesma API usada pelo Riversoft Console Portal, aberta para integrações com outros sistemas e provedores: configurar o ambiente, administrar operadores e permissões, supervisionar as instâncias e consultar relatórios.

A API segue o modelo HTTP/REST e recebe e responde em JSON.

Nota

Para enviar e receber arquivos por API, use a Riversoft STCP DirectLink API, dedicada à transferência.

Principais recursos

Recurso	O que você pode fazer
Autenticação	Login com 2FA, password grant, LDAP, Single Sign-On (SAML 2.0 e OAuth 2.0) e logout.
Configuração	Gerenciar instâncias, usuários, serviços de rede, agendamentos, tipos de arquivo e roteamentos.
Administração	Gerenciar operadores, grupos e permissões, o cadastro da API e os códigos de erro e evento.
Supervisão e manutenção	Consultar e comandar as instâncias, executar agendas, iniciar conexões, gerenciar arquivos de teste e chaves, e redefinir senha, 2FA e bloqueio.
Relatórios	Consultar eventos, atividades de operadores, histórico de transferências, estatísticas e auditoria.

Informações gerais

Propriedade	Valor
Versão do produto	3.10.0
URL base	`https://{host}:{porta}` (porta padrão de exemplo: `33070`)
Protocolo	HTTPS (recomendado; habilitado em `ssl` no `config.json` da API)
Formato	JSON; corpo com `Content-Type: application/json` exatamente assim
Autenticação	Token Bearer: login com 2FA, password grant, LDAP ou SSO
Especificação	OpenAPI 3.0.3 em português, inglês e espanhol

O {host} e a {porta} são os configurados na seção general do config.json da API. Veja Configuração do Riversoft STCP Gemini.

Por onde começar

Início rápido

Obtenha um token e consulte o primeiro relatório.

Autenticação

Escolha o método de autenticação dos operadores.

Guias

Gestão de recursos e consulta de relatórios.

Referência da API

Endpoints, parâmetros, respostas e códigos.

Organização desta documentação

Seção	Para quê
Conceitos	Entender os recursos gerenciados, as permissões e a paginação antes de integrar.
Início rápido	Obter o primeiro token e fazer a primeira consulta.
Segurança	Boas práticas para TLS, credenciais, tokens e auditoria.
Autenticação	Passo a passo de cada método de autenticação.
Guias	Tarefas completas de gestão e de consulta de relatórios.
Solução de problemas	Sintomas comuns e como resolvê-los.
Referência	Contrato de cada endpoint, estrutura do `CONFIG_TXT` e códigos.
Notas de versão	Novidades, correções e mudanças incompatíveis por versão.

Convenções dos exemplos

Os exemplos usam curl e o host ilustrativo api.exemplo.com. Substitua pelo host e pela porta do seu ambiente.
Valores entre < e > nos blocos de código são marcadores a substituir, não valores literais.
Os exemplos leem senhas e códigos com read -s para que não fiquem no histórico do shell.
Os exemplos de resposta mostram o formato dos campos. Os valores reais dependem do ambiente.
Datas nos filtros dos relatórios são Unix timestamps em milissegundos.