Índice
| Índice |
|---|
| maxLevel | 4 |
|---|
| outline | true |
|---|
| exclude | .*ndice |
|---|
| style | none |
|---|
|
Objetivo
O objetivo deste guia é disponibilizar as APIs específicas do LMS da plataforma TOTVS Fluig para consulta.
| Aviso |
|---|
|
Salientamos que essas APIs são válidas para uso, porém, estão em processo de depreciação. |
Visualizar as APIs
Para visualizar as APIs atuais do LMS efetue os seguintes passos:
| Deck of Cards |
|---|
| effectDuration | 0.5 |
|---|
| history | false |
|---|
| id | samples |
|---|
| effectType | fade |
|---|
|
| Card |
|---|
| default | true |
|---|
| id | 1 |
|---|
| label | Passo 1 |
|---|
| O LMS possui duas versões de APIs e é possível visualizar a documentação de cada uma das versões na própria plataforma, acessando o endereço /lms/swagger/{versão}/swagger.json: - versão 2 → {meu_fluig}/lms/swagger/v2/swagger.json.
https://minhaempresa.fluig.com/lms/swagger/v2/swagger.json
|
| Card |
|---|
| Ao acessar os endereços citados no passo anterior, será exibido na página um JSON da API no formato Swagger. - Copie o JSON para colar em um leitor de documentação Swagger on-line para uma melhor visualização da documentação da API.
- Acesse o endereço https://editor.swagger.io e cole o JSON no editor para visualizar a documentação. Após colar o JSON no editor, pode ser que seja apresentado um log com erros de semântica da documentação. Nesse caso, basta clicar em "Hide" para esconde-los e visualizar a documentação das APIs.
 Image Added
À direita é exibido um modelo navegável da documentação onde é possível consultar os caminhos e modelos utilizados da API.
- Caso ainda não visualize, pode ser necessário remover as linhas iniciais que contenham comentários. Exemplo:
| Bloco de código |
|---|
| language | js |
|---|
| title | Linhas a serem removidas |
|---|
| // 20210910105755
// https://fluig.empresa.com/lms/swagger/v2/swagger.json |
|
|
| Aviso |
|---|
|
A partir da atualização 1.6.5-190219, o LMS não faz mais parte da plataforma para novas instalações. Porém se você adquiriu a plataforma com o LMS incluso entre em contato com o Suporte Fluig para que você consiga utiliza-lo normalmente. |