Histórico da Página
Sumário
...
| Índice | ||
|---|---|---|
|
Introdução
...
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".
...
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.
...
1 - APIs de Framework
...
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 |
|---|
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:
...
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.
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas