Serviços

Como exportar serviços utilizando API?

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

  2. Obtenha o ServiceId: Obtenha o código identificador do serviço através da página Construir > Serviços ou no resultado de consultas de API como explicado em Como listar serviços que podem ser iniciados pela pessoa autenticada na API?;

  3. Envie a requisição: Utilize o endpoint Serviços para envio da requisição. Lembre-se de trocar seu_endereco.do.zeev pelo endereço que você utilizar para acessar o Zeev;

Retorna o JSON de exportação do serviço informado (Auth)

get
Autorizações
Parâmetros de rota
serviceIdinteger · int32Obrigatório

ID do serviço que será exportado

Parâmetros de consulta
flowContentsbooleanOpcional

true para retornar o XML de exportação do processo usado pelo serviço

tutorialContentsbooleanOpcional

true para retornar os dados do tutorial configurado para o serviço selecionado

Respostas
200

Sucesso

get
GET /api/2/services/{serviceid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "code": "00000000-0000-0000-0000-000000000000",
  "createdDate": "2025-08-06T20:56:57.081Z",
  "createdBy": "text",
  "type": "text",
  "name": "text",
  "description": "text",
  "keywords": [
    "text"
  ],
  "deploy": true,
  "lastDeploy": "2025-08-06T20:56:57.081Z",
  "teams": [
    {
      "id": 1,
      "code": "text",
      "name": "text"
    }
  ],
  "flow": {
    "id": 1,
    "uid": "00000000-0000-0000-0000-000000000000",
    "name": "text",
    "version": 1,
    "contents": "text",
    "form": [
      {
        "name": "text",
        "value": "text",
        "order": 1
      }
    ]
  },
  "url": "text",
  "sendParametersToUrl": true,
  "tutorial": {
    "id": 1,
    "name": "text",
    "version": 1,
    "createdDate": "2025-08-06T20:56:57.081Z",
    "contents": "text",
    "active": true
  },
  "authorization": {
    "request": {
      "content": [
        "text"
      ]
    },
    "edit": {
      "content": [
        "text"
      ]
    },
    "report": {
      "content": [
        "text"
      ]
    }
  }
}

Exemplo de requisição para exportar serviços

let serviceId = 471;

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

const requestOptions = {
  method: "GET",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/services/${serviceId}?flowContents=true&tutorialContents=true`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

Como importar um serviço utilizando API?

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

  2. Envie a requisição: Utilize o endpoint Serviços para envio da requisição. Lembre-se de trocar seu_endereco.do.zeev pelo endereço que você utilizar para acessar o Zeev;

Importar um novo serviço (Auth)

post
Autorizações
Corpo
typestringObrigatório

Tipo

Pattern: (process|link|onlytutorial)
namestringObrigatório

Nome

descriptionstringOpcional

Descrição

keywordsstring[]Opcional

Palavras-chave

urlstringOpcional

Url do serviço

sendParametersToUrlbooleanOpcional

Enviar parametros para a Url do serviço

validationsstring[]Opcional
Respostas
200

Sucesso

post
POST /api/2/services/import HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 749

{
  "type": "process = (Processo) | link = (Externo) | onlytutorial = (Apenas tutorial) ",
  "name": "Nome do serviço",
  "description": "Descrição do serviço",
  "keywords": [
    "Palavra-chave",
    "Palavra-chave"
  ],
  "teams": [
    {
      "code": "Código de identificação do time a ser vinculado ao serviço"
    }
  ],
  "flow": {
    "uid": "Codigo Uid do processo a ser vinculado ao serviço",
    "contents": "XML resultado da exportação de processo.",
    "form": [
      {
        "name": "Nome do campo do formulário do processo a ser vinculado ao serviço",
        "value": "Valor padrão do campo do formulário do processo a ser vinculado ao serviço"
      }
    ]
  },
  "url": "Url do serviço",
  "sendParametersToUrl": true,
  "tutorial": {
    "name": "Nome do tutorial",
    "version": 1,
    "contents": "Conteúdo do tutorial",
    "required": true,
    "active": true
  }
}
{
  "id": 1
}

Links relacionados:

AnteriorPaíses / Estados / CidadesPróximoGerar documentos

Atualizado