Central de Ajuda

Tire suas dúvidas e aproveite ao máximo nossos serviços

API SRSCloud

GUIA

Bem-vindo à documentação oficial da API SRS!

Aqui você encontrará informações detalhadas sobre os endpoints, autenticação e exemplos de requisições.

A API SRS fornece endpoints organizados por categorias, permitindo a interação com diferentes serviços, como execução de tarefas, gerenciamento de filas, autenticação, notificações e geração de relatórios.

O endereço padrão de acesso é sempre por https://api.srscloud.com.br/

Estrutura dos Endpoints

Os endpoints seguem o seguinte padrão:

/api/<tipo>/<acao>

Onde:

– tipo: define a categoria do serviço (ex: execucao, fila, credencial, etc.).

– acao: define a operação a ser realizada dentro da categoria.

Endpoints Disponíveis

Execução de Processos

• /api/execucao/iniciar - Inicia um novo processo.

• /api/execucao/log - Registra logs da execução.

• /api/execucao/finalizar - Finaliza um processo.

Gerenciamento de Filas

• /api/fila/inserir - Insere uma nova tarefa na fila.

• /api/fila/proximo - Retorna a próxima tarefa da fila.

• /api/fila/atualizar - Atualiza uma tarefa na fila.

• /api/fila/consultar - Consulta o estado atual da fila.

Autenticação e Credenciais

• /api/credencial/obter - Obtém credenciais de um usuário.

• /api/credencial/atualizar - Atualiza credenciais de um usuário.

Tarefas e Execução

• /api/tarefa/parametro - Obtém parâmetros de uma tarefa.

• /api/tarefa/executar - Executa uma tarefa específica.

Ações em Telas

• /api/tela/abrir - Abre uma interface específica.

Certificados

• /api/certificado/obter - Obtém informações de um certificado.

Notificações

• /api/notificacao/notificar - Envia uma notificação para um usuário.

Relatórios

• /api/relatorio/relatorio_atividade - Relatório de atividades.

• /api/relatorio/relatorio_auditoria - Relatório de auditoria.

• /api/relatorio/relatorio_maquina - Relatório de máquinas.

• /api/relatorio/relatorio_sistema - Relatório do sistema.

• /api/relatorio/relatorio_execucao - Relatório de execuções.