Utilizando API REST 2021

Sumário:

1. Conceito de utilização
2. Editar Ocorrências
3. Métodos consultar

Esta API pode ser acessada por usuários que possuam login e senha no sistema. O acesso é feito pelo caminho:

<caminho do sistema>/webservices/rest/api.php (quando a aplicação for mantida pela Multidados)
ou
<caminho do sistema>/webservices/rest/ (em certos casos de aplicações mantidas em um servidor interno do cliente).

É possível enviar dados pelos métodos:

GET ou POST, sendo que a diferença entre eles é a forma como os dados são enviados para a aplicação:

• GET: os dados são encaminhados como parâmetros na URL;
• POST: os dados serão encaminhados no formato JSON no corpo do envio.
  
  

Cada método tem suas particularidades de envio de dados, que são explicadas na própria página. Contudo, segue agora uma breve explicação de cada método:

2. Editar Ocorrências

Serve para modificar o status atual de uma ocorrência. Permite também alterar campos adicionais e enviar arquivos. Lembre-se que os dados solicitados nas integrações serão sempre o código do campo, como por exemplo, o código do status (normalmente não solicitamos IDs).

Para encaminhar campos adicionais, é primeiro importante saber se são campos de ocorrência, de cliente ou de projeto. Cada um destes tipos corresponde a um parâmetro diferente. Cada parâmetro receberá um JSON com uma lista dos campos a serem alterados:

Ex: campos_variaveis_ocorrencia: [{“codigo”:”<codigo_campo_1>”,”valor”:”<valor_campo_1>”},{“codigo”:”<codigo_campo_2>”,”valor”:”<valor_campo_2>”}]

para enviar arquivos, utilizamos o parâmetro anexo_base64:

Ex: {“name”:”exemplo.png”, “size”: 16900, “type”: “PNG”, “base64”: “data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAlgAAAJYCAYAAAC+ZpjcAAAACXBIWXMAAAsTAAALEwEAmpwYAAAgAElEQVR4nO3dB3Qc5bn/cZkaQgpw”, “md5_hash”: “”}

O envio do md5_hash não é obrigatório. Ele tem por função validar que o arquivo recebido é o mesmo que foi enviado. Quando for enviado, o sistema fará um hash do arquivo recebido e fará a comparação com o hash enviado. O hash deve ser feito do ARQUIVO e não do base64 dele.

3. Métodos Consultar

Cobre todos os métodos de consulta como Consultar Clientes, Consultar Ocorrências e Consultar Narrativas. Os parâmetros padrão de envio sempre são:

• usuario_ws: Usuário no sistema Multidados
• senha_ws: Senha do usuário no sistema Multidados
• campos_dinamicos: Um JSON com uma lista de filtros que serão utilizados na pesquisa
• return_dinamicos: Um JSON com a lista de campos a serem retornados na pesquisa
• api_method: Quando o endpoint termina com “api.php” o método não faz parte da URL e precisa ser passado como parâmetro. Pode ser encontrado no título do método, entre parênteses.

Ao acessar a tela do método de consulta, você encontrará 2 caixas de seleção: Filtros e Retornos. Estas caixas possuem pesquisa para facilitar localizar os campos desejados e permitem múltipla escolha:

Filtros

Campos a serem retornados:

Uma vez escolhidos os dois, clique em Adicioar e um exemplo dos JSONs a serem enviados será gerado com seus campos:

Passando parâmetros por GET:

Passando parâmetros por POST: