Especificação OpenAPI
O contrato formal da Riversoft® STCP Gemini API está disponível no formato OpenAPI 3.0.3, compatível com Swagger UI, Postman, Insomnia e geradores de cliente do ecossistema OpenAPI. Ele cobre todos os endpoints usados pelo Riversoft Console Portal, que também ficam disponíveis para integração com outros sistemas.
Download
| Idioma | Arquivo |
|---|---|
| Português | openapi.pt.yaml |
| English | openapi.en.yaml |
| Español | openapi.es.yaml |
As três versões têm os mesmos endpoints, métodos, parâmetros, operationId, schemas, regras de autenticação e exemplos. O idioma muda apenas os resumos, as descrições e os nomes dos grupos; não muda o idioma das respostas da API.
Conteúdo
| Grupo | Endpoints |
|---|---|
| Autenticação e Single Sign-On | Emissão do token, login com 2FA (TOTP), logout e retornos de SAML 2.0 e OAuth 2.0. |
| Informações | Versão, situação das conexões com os bancos, licença e provedores de login. Não exigem token. |
| Configuração | Instâncias, usuários, serviços de rede, agendamentos, tipos de arquivo e roteamentos. |
| Administração | Operadores, grupos e permissões, cadastro da API e códigos de erro e evento. |
| Supervisão e manutenção | Comandos aos serviços de supervisão, arquivos de sandbox e keystore e redefinição de senha, bloqueio e 2FA. |
| Relatórios | Eventos, atividades de operadores, transferências e auditoria. |
Cada operação indica a permissão exigida no scope do operador. Veja Operadores e permissões.
Servidor
O servidor declarado na especificação (https://api.exemplo.com:33070) é ilustrativo. Antes de gerar um cliente ou testar chamadas, substitua-o pelo endereço da API do seu ambiente.