Histórico da Página
Sumário
...
| Índice | ||
|---|---|---|
|
...
1 - APIs de Framework e swagger
...
API é um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software ou plataforma baseado na Web. A sigla API refere-se ao termo em inglês "Application Programming Interface" que significa em tradução para o português "Interface de Programação de Aplicativos".
Uma API é criada quando uma empresa de software tem a intenção de que outros criadores de software desenvolvam produtos associados ao seu serviço. Existem vários deles que disponibilizam seus códigos e instruções para serem usados em outros sites da maneira mais conveniente para seus usuários.
Através das APIs, os aplicativos podem se comunicar uns com os outros sem conhecimento ou intervenção dos usuários. Elas funcionam através da comunicação de diversos códigos, definindo comportamentos específicos de determinado objeto em uma interface. A API liga as diversas funções em um site de maneira que possam ser utilizadas em outras aplicações. De modo geral, a API é composta de uma série de funções acessíveis somente por meio de programação.
Recentemente, a utilização das APIs tem se espalhado nos plugins, que complementam a funcionalidade de um determinado programa. Os desenvolvedores de um programa principal criam uma API específica e fornecem a outros criadores, que desenvolvem plugins para aumentar o potencial e as funcionalidades do programa.
Os sistemas operacionais também possuem suas APIs com as mesmas funções descritas acima. Por exemplo, o Windows possui APIs como a Telephony API, Win16 API e Win32 API. Quando um usuário executa um programa que envolva algum processo do sistema operacional, é bem provável que o Windows faça uma conexão entre o software e alguma de suas APIs.
Objetivo
O objetivo desse documento é apresentar os principais métodos e endpoints da API de Usuários, necessários para ver as informações, incluir, excluir ou editar um usuário no RM.
O aplicativo RM.Host é responsável por hospedar e expor os serviços de APIs. Veja mais sobre a configuração da porta webApi.
Abaixo estão listadas as APIs de Framework:
| Exibir filhos |
|---|
| Expandir | ||
|---|---|---|
| ||
Através do link http://{dominio}:{porta}/api/swagger/ disponibilizado pelo RM.Host.exe, é possível listar todas as api's da linha RM, disponíveis. Nesse endereço é possível visualizar todos os métodos implementados, o formato ao ser utilizado nos dados de entrada, o formato dos dados de saída, entre outras informações sobre as api's desenvolvidas.
Desabilitar o SwaggerPara desabilitar o acesso ao Swagger pelo link acima, é necessário adicionar a seguinte chave ao <appSettings> do RM.Host.exe.config: <add key="DisableSwagger" value="true" /> O FrameHTML também possui um acesso ao Swagger pela URL http://{dominio}:{porta}/swagger/; para desabilitá-lo, adicione a chave acima ao <appSettings> do Web.config, localizado na pasta FrameHTML. |
2
...
- Padrões
...
Na API de Usuário é utilizado dois padrões:
- Guia de API Totvs
- SCIM
...
2.1 - Guia de API Totvs
...
Este guia define os padrões que devem ser adotados durante a implementação de novas APIs publicas ou privadas na plataforma TOTVS incluindo:
- Definir práticas e padrões consistentes para todos os endpoints das APIs da TOTVS;
- Garantir a utilização mais próxima possível das boas práticas estipuladas pelos padrões REST/HTTP;
- Tornar os serviços da TOTVS acessíveis através de APIs facilmente compreendidas e documentadas para desenvolvedores e consumidores.
Mais em "Guia de implementacao das APIs TOTVS"
...
2.2 - SCIM
...
O SCIM (System for Cross-domain Identity Management ou Sistema de Gerenciamento de Identidade de Domínio Cruzado) é um padrão aberto para automatizar a troca de informações de identidade do usuário entre domínios de identidade e aplicações.
...
3 - Métodos
...
Na API de Usuários estão expostos os métodos:
- GET
- POST
- PUT
- DELETE
Especificações
| Especificações | Título | Comentário |
|---|---|---|
| RFC 7231, sessão 4: Request methods | Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content | Especifica os métodos GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE. |
| RFC 5789, sessão 2: Patch method | PATCH Method for HTTP | Especifica o método PATCH. |
...
3.1 - GET
...
O Método GET solicita a representação de um recurso específico. Requisições utilizando o Método GET devem retornar apenas dados.HEAD O Método HEAD solicita uma resposta de forma idêntica ao método GET, porém sem conter o recurso "body"(corpo).
...
3.2 - POST
...
O Método POST é utilizado para submeter uma entidade a um recurso específico, às vezes causando uma mudança no estado do recurso ou solicitando alterações ao servidor.
...
3.3 - PUT
...
O Método PUT substitui todas as atuais representações de seu recurso alvo pela carga de dados da requisição.
...
3.4 - DELETE
...
O Método DELETE remove um recurso específico.
4 - Lembretes
...
Importante: Lembre-se que ao informar valores inteiros para propriedades, eles devem ser informados sem o 0 (zero) à esquerda. Caso seja enviado com o 0 (zero), o valor inteiro deve estar entre aspas duplas:
Ex.: "day": 8 ou "day": "08".
Isso acontece porque ao utilizar um inteiro com um 0 a esquerda o C# entende que este inteiro é base Octal ( de 0 a 7) onde os caracteres 8 e 9 são inválidos.
5 - Consumo de Licença pelo License Server
...
| Informações | ||
|---|---|---|
| ||
O consumo de Licença foi desativado para as seguintes APIs:
A partir das versões e patchs listados abaixo:
Para demais versões anteriores o consumo permanece ativado. |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas