Criar / abrir solicitações via API

Como criar instâncias de solicitação utilizando as API's do Zeev?

Para criar instâncias de solicitação usando as APIs do Zeev, você precisa seguir alguns passos simples:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Fornecimento de Parâmetros: Você precisa fornecer informações importantes na requisição, como quem está fazendo a solicitação e o que precisa ser feito. Essas informações são enviadas no corpo da requisição HTTP e estão disponíveis no fim desta página com a documentação e exemplo. para obter mais informações.

3. Chamada HTTP: Você deve fazer uma chamadas HTTP para o endpoint Criar / abrir solicitações via API (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev). Endpoints são como portas que levam você a diferentes partes da aplicação. Cada endpoint pode ser usado para fazer algo específico, como criar uma nova solicitação;

4. Rate limit: Se for criar instâncias em lote, respeite os limites máximos de solicitações;

Seguindo esses passos simples, você pode usar as APIs do Zeev para criar solicitações e interagir com a aplicação de forma eficiente e segura.

Criar uma nova instância de solicitação (Auth)

post

Corpo

application/json

flowIdinteger · int32 · mín: 1 · máx: 2147483647Obrigatório

Identificador do processo a ser iniciado

serviceIdinteger · int32Opcional

Identificador do serviço a ser iniciado

isSimulationbooleanObrigatório

Indicador se é uma simulação

teamIdinteger · int32Opcional

Identificador do time/área do solicitante

positionIdinteger · int32Opcional

Identificador da função/posição do solicitante

resultstring · máx: 64Opcional

Indicador ou descritivo da ação / resultado selecionado

Respostas

200

Sucesso

application/jsontext/jsontext/xml

400

Solicitação ou dados da solicitação são inválidas

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

Pessoa não tem permissão de executar essa operação

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

Muitas requisições em um determinado período de tempo

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

post

/api/2/instances

HTTPcURLJavaScriptPython

POST /api/2/instances HTTP/1.1
Host: seu_endereco.do.zeev
Content-Type: application/json
Accept: */*
Content-Length: 573

{
  "flowId": 100,
  "isSimulation": false,
  "teamId": 10,
  "positionId": 20,
  "result": "3",
  "formFields": [
    {
      "id": 0,
      "name": "razaoSocial",
      "value": "SML",
      "row": 1
    },
    {
      "id": 0,
      "name": "cidade",
      "value": "São Paulo",
      "row": 1
    }
  ],
  "messages": [
    {
      "messageBody": "Aqui vai o texto de uma mensagem que o solicitante pode ver",
      "requesterCanSee": true
    },
    {
      "messageBody": "Aqui vai o texto de uma mensagem que o solicitante NÃO pode ver",
      "requesterCanSee": false
    }
  ],
  "files": [
    {
      "filename": "fotodorg.png",
      "resume": "Esse é o RG do solicitante",
      "requesterCanSee": true,
      "docType": "rg",
      "base64Content": "<conteúdo em Base64>"
    }
  ]
}

{
  "id": 1
}

Exemplos de requisição

Node.js

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const raw = JSON.stringify({
  "flowId": 100,
  "isSimulation": false,
  "teamId": 10,
  "positionId": 20,
  "result": "3",
  "formFields": [
    {
      "id": 0,
      "name": "razaoSocial",
      "value": "SML",
      "row": 1
    },
    {
      "id": 0,
      "name": "cidade",
      "value": "São Paulo",
      "row": 1
    }
  ],
  "messages": [
    {
      "messageBody": "Aqui vai o texto de uma mensagem que o solicitante pode ver",
      "requesterCanSee": true
    },
    {
      "messageBody": "Aqui vai o texto de uma mensagem que o solicitante NÃO pode ver",
      "requesterCanSee": false
    }
  ],
  "files": [
    {
      "filename": "fotodorg.png",
      "resume": "Esse é o RG do solicitante",
      "requesterCanSee": true,
      "docType": "rg",
      "base64Content": "<conteúdo em Base64>"
    }
  ]
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw
};

try {
  const response = await fetch("https://seu_endereco.do.zeev/api/2/instances", requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Vídeos relacionados:

• Abrir uma solicitação por API

• Abrir uma solicitação por API com envio de arquivos e personificação

Links relacionados:

• O que é preciso para fazer integrações do Zeev para outros sistemas?

• Como autenticar nas APIs do Zeev

• Como controlar o volume máximo de requisições à APIs

• Como acessar o Swagger / OpenAPI

• Como iniciar uma solicitação