Dynamique

https://cloud.fenixsd.com.br/api

Este documento tem como objetivo apresentar todos os procedimentos necessários para abrir a parte de integração de API do sistema Dynamique e como mandar e receber informações do sistema Dynamique.

Para acessar essa área precisa ir na URll e colocar depois do .com/api para acessar o API do Dynamique com as informções.

O primeiro passo para fazer a integração é se logar no Api para gerar um Token de acesso, assim a pessoa podera mexer no api sem que seja barrada pelo sistema. Sempre que for mexer em determina área do API Dynamique, na plataforma de integração da sua empresa você deve seguir o que tem depois do “data:”. O “POST” significa que mandará informações para o Dynamique, o /api/login é a para onde mandará a informação que você escreverá. A onde tem o segundo “user” deverá colocar o usuário que esta cadastrado no ambiente, e o segundo “pass” deverá colocar a senha do usuário. Logo apos isso basta dar Send e ele ira fazer o login com a plataforma. Quando fizer o login aparecerá uma mensagem, se tiver algo de errado em vez de ter “error”: 0, terá “error”:1, ou qualquer outro número significa que teve alguma informação errada e aparecerá no lugar do código do “msg” uma mensagem que tem algo errado. Caso tudo esteja de acordo poderá fazer as modificações.

POST /login

Request headers

content-type

string optional

Request body

application/json

Object

user

string

Example:

nilo@fenixsd.com.br

pass

string

Example:

123

Responses

200 OK

application/json

Headers

content-type

string optional

Body

application/json

Example 2

POST https://cloud.fenixsd.com.br/api/login HTTP/1.1 
Content-Type: application/json

{
    "user": "nilo@fenixsd.com.br",
    "pass": "123"
}

HTTP/1.1 200 OK

Depois de ter feito o login precisa ser validado o token de acesso para continuar conectado no sistema por até 2 horas . Para fazer isso tem que se copiar o que esta em “msg”: e colocar em e depois inserir no Headeres com o Código, Para assim acontecer a validação.

Esse JSON serve para buscar formulário ja cadastrados no sistema e que estejam disponíveis para o usuário logado na API. Retorna uma lista com o ID e propriedades dos formulários. Isso será usado para fazer futuras alterações se forem necessárias no formulário.

Com esse Json consegue pegar as informações dos formulários pelo e ID e trazer tudo o que esta contido nele. Com as seguinte interface:

Interface para obter o registro e dados de um formulário pelo Id do formulário e Id do Registro. Retorna os dados do registro do formulário.

Interface para obter a estrutura do formulário pelo id. Retorna os atributos dos campos do formulário.

Interface para obter dados do formulário baseado em condições. Retorna os registros e dados do formulário.

Interface para definir dados num formulário. Retorna mensagem de status, Id do registro gerado e os dados que foram enviados na requisição.

Interface para inserir um documento num registro do formulário. Retorna status.

Interface para excluir um registro do formulário pelo primeiro campo do formulário. Retorna status.

Interface para excluir um registros do formulário pelo Id do Registro. Retorna status.

Interface para atualizar o valor de um campo no registro. Retorna status.

Interface para obter os processos disponíveis para o usuário logado na API. Retorna uma lista com o ID e propriedades dos processos.

Interface para obter o status do processo por Id da execução. Retorna o status do processo.

Interface para iniciar um processo. Retorna status.

GET /form

Request headers

TOKEN

string optional