STISOFT API (1.0.0)

Documentação da API do STISOFT

Pessoas

Dados cadastrais de pessoas

Retorna uma lista de pessoas

Rate Limit: máximo de 10 requisições por minuto por token + IP. Ao exceder o limite, a API retornará 429 Too Many Requests.

query Parameters

page	integer Default: 1 Número da página
identificador	string Identificador da pessoa
ativa	boolean Indica se a pessoa está ativa

Responses

Response samples

Content type

application/json

{"code": 200,
"status": "OK",
"data": [{"id": 0,
"login": "string",
"identificador": "string",
"nome": "string",
"email": "string",
"nome_empresa": "string",
"matricula": "string",
"ativa": true,
"data_criacao": "string",
"data_ultima_ativacao": "string",
"data_hora_ultimo_acesso": "string",
"quantidade_acessos": 0,
"grupos": [{"id": 0,
"nome": "string",
"tipos": [{"id": 0,
"nome": "string"
}
]
}
]
}
],
"links": {"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"to": 0,
"path": "string",
"per_page": 0
}
}

Acessos

Histórico de acessos de pessoas

Retorna o histórico de acessos de pessoas

Rate Limit: máximo de 10 requisições por minuto por token + IP. Ao exceder o limite, a API retornará 429 Too Many Requests.

query Parameters

page	integer Default: 1 Número da página
dataInicio required	string <date> Data de início inicial
dataFim required	string <date> Data de início final
identificador	string Identificador da pessoa

Responses

Response samples

Content type

application/json

{"code": 200,
"status": "OK",
"data": [{"id_pessoa": 0,
"login": "string",
"identificador": "string",
"pessoa_nome": "string",
"pessoa_email": "string",
"id_curso": 0,
"nome_curso": "string",
"id_historico_curso": 0,
"data_inicio_curso": "string",
"data_conclusao_curso": "string",
"data_validade_curso": "string",
"data_proxima_renovacao_curso": "string",
"renovando_aula": true,
"status_curso": "string",
"id_aula": 0,
"nome_aula": "string",
"id_historico_aula": 0,
"data_inicio_aula": "string",
"data_conclusao_aula": "string",
"data_proxima_renovacao_aula": "string",
"status_aula": "string",
"percentual_conclusao_curso": 0
}
],
"links": {"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"to": 0,
"path": "string",
"per_page": 0
}
}

Históricos

Histórico de cursos e aulas de pessoas

Retorna todos os históricos de cursos e aulas de uma pessoa

Rate Limit: máximo de 10 requisições por minuto por token + IP. Ao exceder o limite, a API retornará 429 Too Many Requests.

query Parameters

page	integer Default: 1 Número da página
identificador required	string Identificador da pessoa
dataInicioIni	string <date> Data de início inicial
dataInicioFim	string <date> Data de início final
dataConclusaoIni	string <date> Data de conclusão inicial
dataConclusaoFim	string <date> Data de conclusão final

Responses

Response samples

Content type

application/json

{"code": 200,
"status": "OK",
"data": [{"id_pessoa": 0,
"login": "string",
"identificador": "string",
"pessoa_nome": "string",
"pessoa_email": "string",
"id_curso": 0,
"nome_curso": "string",
"id_historico_curso": 0,
"data_inicio_curso": "string",
"data_conclusao_curso": "string",
"data_validade_curso": "string",
"data_proxima_renovacao_curso": "string",
"renovando_aula": true,
"status_curso": "string",
"id_aula": 0,
"nome_aula": "string",
"id_historico_aula": 0,
"data_inicio_aula": "string",
"data_conclusao_aula": "string",
"data_proxima_renovacao_aula": "string",
"status_aula": "string",
"percentual_conclusao_curso": 0
}
],
"links": {"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"to": 0,
"path": "string",
"per_page": 0
}
}

Cursos

Situação, histórico e conclusões de cursos

Retorna a situação dos cursos das pessoas

Retorna uma lista com a situação dos cursos vinculados às pessoas, incluindo dados do histórico e regras de acesso.

Rate Limit: máximo de 10 requisições por minuto por token + IP. Ao exceder o limite, a API retornará 429 Too Many Requests.

query Parameters

cursoId	integer Default: 1 Filtra pelo id do curso
dataInicioIni	string <date> Example: dataInicioIni=yyyy-mm-dd Data de início inicial
dataInicioFim	string <date> Example: dataInicioFim=yyyy-mm-dd Data de início final
dataConclusaoIni	string <date> Example: dataConclusaoIni=yyyy-mm-dd Data de conclusão inicial
dataConclusaoFim	string <date> Example: dataConclusaoFim=yyyy-mm-dd Data de conclusão final
dataValidadeIni	string <date> Example: dataValidadeIni=yyyy-mm-dd Data de validade inicial
dataValidadeFim	string <date> Example: dataValidadeFim=yyyy-mm-dd Data de validade final
dataRenovacaoIni	string <date> Example: dataRenovacaoIni=yyyy-mm-dd Data de renovação inicial
dataRenovacaoFim	string <date> Example: dataRenovacaoFim=yyyy-mm-dd Data de renovação final
pessoaIdentificador	string Example: pessoaIdentificador=Busque pelo identificador da pessoa conforme configurado na plataforma Identificador da pessoa
historicoStatus	string Enum: "NAO_INICIOU" "EM_ANDAMENTO" "CONCLUIDO" "PENDENTE_RENOVACAO" "NOVA_AULA" Example: historicoStatus=NAO_INICIOU,EM_ANDAMENTO Filtre pelo status do histórico do curso, informando um ou mais status separados por vírgula.
page	integer Default: 1 Número da página
cursoAcessoPermitido	boolean Default: true Filtra os cursos com base na permissão de acesso da pessoa. Quando não informado, o padrão é true, retornando apenas os cursos que a pessoa tem permissão de acesso.

Responses

Response samples

Content type

application/json

{"code": 200,
"status": "OK",
"data": [{"pessoa_id": 100000001,
"pessoa_identificador": "000001-abc",
"pessoa_nome": "NOME DA PESSOA",
"pessoa_tipo_documento": "CPF",
"pessoa_documento": "00000000000",
"pessoa_tipos_grupos": [{"id": 1,
"nome": "CARGO",
"identificador": "string",
"grupos": [{"id": 1,
"nome": "Nome do Grupo"
}
]
}
],
"pessoa_regras": [{"id": 1,
"tipo": "GRUPOS",
"nome": "Nome da Regra"
}
],
"curso_id": 1,
"curso_nome": "Nome do Curso",
"curso_regras": [{"id": 1,
"tipo": "GRUPOS",
"nome": "Nome da Regra"
}
],
"curso_carga_horas": "00:30:00",
"historico_id": 0,
"historico_turma_id": 0,
"historico_data_inicio": "2024-01-01 08:00:00",
"historico_data_conclusao": "2024-01-01 08:30:00",
"historico_data_validade": "2025-01-01",
"historico_data_renovacao": "2025-01-01",
"historico_dias_para_renovacao": 365,
"historico_status": "EM_ANDAMENTO",
"historico_percentual": "39.00",
"curso_acesso_permitido": true
}
],
"links": {"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"to": 0,
"path": "string",
"per_page": 0
}
}

Retorna os históricos de cursos das pessoas

Retorna os históricos de cursos das pessoas. Caso não seja passado nenhum parâmetro, serão retornados todos os históricos de cursos ordenados por data de início, conclusão e renovação decrescente e pelo nome da pessoa ascendente.

Rate Limit: máximo de 10 requisições por minuto por token + IP. Ao exceder o limite, a API retornará 429 Too Many Requests.

query Parameters

page	integer Default: 1 Número da página
dataInicioIni	string <date> Example: dataInicioIni=yyyy-mm-dd Data de início inicial
dataInicioFim	string <date> Example: dataInicioFim=yyyy-mm-dd Data de início final
dataConclusaoIni	string <date> Example: dataConclusaoIni=yyyy-mm-dd Data de conclusão inicial
dataConclusaoFim	string <date> Example: dataConclusaoFim=yyyy-mm-dd Data de conclusão final
dataRenovacaoIni	string <date> Example: dataRenovacaoIni=yyyy-mm-dd Data de renovação inicial
dataRenovacaoFim	string <date> Example: dataRenovacaoFim=yyyy-mm-dd Data de renovação final
pessoaIdentificador	string Example: pessoaIdentificador=Busque pelo identificador da pessoa conforme configurado na plataforma Identificador da pessoa
historicoStatus	string Enum: "EM_ANDAMENTO" "CONCLUIDO" "PENDENTE_RENOVACAO" "NOVA_AULA" Example: historicoStatus=EM_ANDAMENTO,CONCLUIDO Busque pelo status dos históricos dos cursos, informando um ou mais status separados por vírgula.

Responses

Response samples

Content type

application/json

{"code": 200,
"status": "OK",
"data": [{"pessoa_id": 0,
"pessoa_identificador": "string",
"pessoa_nome": "string",
"pessoa_tipo_documento": "CPF",
"pessoa_documento": "12345678900 ou 12345678000195",
"curso_id": 0,
"nome_curso": "string",
"turma_id": 0,
"historico_id": 0,
"data_hora_inicio": "2023-10-01 12:00:00",
"data_hora_conclusao": "2023-10-01 12:10:00",
"data_validade": "2019-08-24",
"data_renovacao": "2024-10-01",
"dias_para_renovacao": 365,
"carga_horas": "00:15:00",
"status": "EM_ANDAMENTO",
"percentual": "100.00"
}
],
"links": {"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"to": 0,
"path": "string",
"per_page": 0
}
}

Diálogos de Segurança

Diálogos de segurança disponibilizados

Retorna uma lista de diálogos de segurança disponibilizados

Retorna uma lista de diálogos de segurança

Rate Limit: máximo de 10 requisições por minuto por token + IP. Ao exceder o limite, a API retornará 429 Too Many Requests.

query Parameters

pessoa_identificador	string Identificador da pessoa
data_inicio_disponibilizacao	string <date> Data de início da disponibilização
data_fim_disponibilizacao	string <date> Data de fim da disponibilização

Responses

Response samples

Content type

application/json

{"code": 200,
"status": "OK",
"data": [{"pessoa_identificador": "string",
"pessoa_nome": "string",
"pessoa_tipo_documento": "string",
"pessoa_documento": "string",
"data_hora_acessou": "string",
"data_hora_concluiu": "string",
"tentativas": "Limitada",
"limite_tentativas_dialogo_seguranca": 0,
"quantidade_tentativas_realizadas": 0,
"aprovado": true,
"status_pessoa": "string",
"tema": "string",
"assunto": "string",
"idioma": "string",
"data_inicio_disponibilizacao": "string",
"data_fim_disponibilizacao": "string",
"data_prorrogacao_disponibilizacao": "string",
"data_hora_cancelamento": "string",
"motivo_cancelamento": "string",
"usuario_cancelou": "string",
"status_dialogo_seguranca": "string"
}
],
"links": {"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"to": 0,
"path": "string",
"per_page": 0
}
}