Referência
Referência da API
Esta seção é a fonte de consulta do contrato da API. Para exemplos passo a passo, veja os Guias.
Convenções
| Item | Valor |
|---|---|
| URL base | https://{host}:{porta} |
| Credencial nas rotas protegidas | Authorization: Bearer <access_token> |
| Corpo das requisições de token | application/x-www-form-urlencoded |
| Corpo das requisições de gestão | application/json, informado exatamente assim no Content-Type |
| Corpo das respostas | application/json |
| Validade do token | 60 minutos por padrão; ajustável em session_duration (máximo 720 minutos) |
| Datas nos filtros | Unix timestamp em milissegundos |
Catálogo de endpoints
A Riversoft STCP Gemini API é a mesma usada pelo Riversoft Console Portal. Todos os endpoints abaixo estão disponíveis para integração. O contrato completo de cada um, com parâmetros, corpos, respostas e exemplos, está na Especificação OpenAPI.
| Grupo | Caminho base | Acesso | Conteúdo |
|---|---|---|---|
| Autenticação | /oauth, /disconnect | Público / Bearer | Token (/oauth/token, /oauth/v2/token), conclusão do 2FA (/oauth/v2/token/mfa/{challengeID}) e logout. Veja Autenticação. |
| Single Sign-On | /auth/api/v1/sso | Público | Início do login SSO e retornos de SAML 2.0 e OAuth 2.0. |
| Informações | /info | Público | version, status, report, license e sso/providers. |
| Configuração | /stcpcore/v2 | Bearer | Instâncias, usuários, serviços de rede, agendamentos, tipos de arquivo e roteamentos. Veja Recursos de gestão. |
| Administração | /stcpadmin/v2 | Bearer | Operadores, grupos e permissões, cadastro da API (settings), políticas de senha e códigos de erro e evento. |
| Supervisão | /stcpadminsvc/v2/supervision/stcpmon | Bearer | Comandos aos serviços de supervisão e arquivos de sandbox e keystore. |
| Manutenção | /stcpadminsvc/v2/supervision/stcpauth | Bearer | Redefinição e troca de senha, desbloqueio, hash e 2FA de usuários e operadores. |
| Relatórios | /reports/v2 | Bearer | Eventos, atividades de operadores, transferências e auditoria. Veja Relatórios. |
Nesta seção
Contrato OpenAPI 3.0.3 de todos os endpoints da Riversoft STCP Gemini API, com visualização interativa.
Contrato da emissão do token, do login com 2FA, do Single Sign-On e do logout.
Contrato dos endpoints /reports/v2: system, users, instance, operators, transfers e auditoria.
Endpoints de gestão de instâncias, usuários, serviços de rede, agendamentos, tipos de arquivo, roteamentos, operadores, grupos, cadastro da API, supervisão e manutenção.
Status HTTP retornados pela Riversoft STCP Gemini API.