Base de informações da plataforma > Integração através de API (REST)

Implantação e configuração da API (REST)

RTSYSINF.RQ-013

Descrição

A API REST já vem automaticamente instalada. A única coisa necessária para o seu uso é:

Configurar quais serviços estarão disponíveis.
Disponibilizar as credenciais de acesso a serem utilizadas.
Disponibilizar a documentação dos serviços configurados.

Fluxo normal

Configurar serviços

A configuração de serviços que estarão disponíveis pela API é feita da mesma forma que é feita para o acessos dos usuários. Sugere-se criar uma função específica para acesso por API. Se existirem diferentes parceiros que acessam o sistema através de API para contextos diferentes, sugere-se ter uma função para cada tipo de integração. Exemplo: API_FINANCEIRO e API_COMERCIAL.

Em cada função, deve-se configurar todas as operações que poderão ser realizadas por API.

Relação operações x método REST

Operações suportadas:

Operação	Método	URI	Observações
CUSTOM	PUT	/feature?query	Ver funcionamento em tópico abaixo
CUSTOM_ACTION	POST	/feature	Ver funcionamento em tópico abaixo
DELETE	DELETE	/id	Exclui o registro do ID informado
DELETE_ALL	DELETE	/?query	Exclui todos os registros conforme filtro indicado
INSERT	POST	/	Cria um novo registro
LIST	GET	/?query	Retorna ARRAY com todos os registros atendidos pela query
QUERY	-	-	Usada através das operações de LIST, CUSTOM e DELETE_ALL
RECORD_ACTION	POST	/id/feature	Executa a record action em um registro
UPDATE	PUT	/id	Altera um registro
VIEW	GET	/id	Retorna os dados de um registro

Operações não suportadas:

Operação	Método	URI
CALENDAR	-	-
CHART	-	-
EXPORT	-	-
IMPORT	-	-
LABEL	-	-
PIVOT_TABLE	-	-
REPORT	-	-
ROLE	-	-
SEARCH	-	-
SHEET	-	-
UPDATE_ALL	-	-
UPGRADE	-	-

Disponibilizar credenciais

As credenciais são um usuário normal do sistema, que terá acesso apenas à função criada acima (ou às funções se assim for desejado).
Ao cadastrar este usuário, deve ser removida a função "TODOS_USUARIOS" (se houver) e incluída a função cadastrada com os serviços desejados.
Em seguida deve ser criado um token de acesso através da interface Tokens de acesso.

Disponibilizar a documentação

Para que o parceiro consiga integrar, ele terá de receber uma documentação técnica sobre os serviços disponíveis para ele. Essa documentação pode ser gerada a partir da interface Documentação API (REST).