> For the complete documentation index, see [llms.txt](https://kb.stoque.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.stoque.com.br/zeev/apis/all/others/executeintegration.md).

# Executar integração

## Como executar integrações utilizando API?

Para executar uma integração cadastrada no Zeev, siga os passos abaixo:

1. **Autenticação**: Primeiro obtenha um [token de autenticação](https://kb.zeev.it/apis/como-gerar-tokens-para-autenticar-nas-apis) com permissão de realizar essa operação;
2. **IntegrationUID**: Obtenha o UID da integração a ser executada na página de cadastro da mesma;
3. **Enviar requisição:** Utilize o endpoint [#api-2-integrations-integrationuid-execute](#api-2-integrations-integrationuid-execute "mention");

## Executar uma integração a partir do UID, retornando os valores transformados da mesma.

> \[<https://kb.stoque.com.br/zeev/apis/all/others/executeintegration]\\(https://kb.stoque.com.br/zeev/apis/all/others/executeintegration)>

```json
{"openapi":"3.1.1","info":{"title":"API RESTFul versão 2.0 ","version":"2"},"servers":[{"url":"https://seu_endereco.do.zeev"}],"paths":{"/api/2/integrations/{integrationuid}/execute":{"post":{"tags":["Integrations / Integrações"],"summary":"Executar uma integração a partir do UID, retornando os valores transformados da mesma.","description":"[https://kb.stoque.com.br/zeev/apis/all/others/executeintegration](https://kb.stoque.com.br/zeev/apis/all/others/executeintegration)","operationId":"Integrations_ExecuteIntegration","parameters":[{"schema":{"type":"string"},"name":"integrationUID","in":"path","description":"Código UID que identifica a integração.","required":true},{"schema":{"type":"integer","format":"int32"},"name":"integrationExecutionModel.instanceId","in":"query","required":false},{"schema":{"type":"integer","format":"int32"},"name":"integrationExecutionModel.serviceId","in":"query","required":false},{"schema":{"type":"integer","format":"int32"},"name":"integrationExecutionModel.flowId","in":"query","required":false},{"schema":{"type":"integer","format":"int32"},"name":"integrationExecutionModel.fieldId","in":"query","required":false},{"schema":{"type":"string"},"name":"integrationExecutionModel.filter","in":"query","required":false}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionTransformedModelResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionTransformedModelResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionTransformedModelResult"}}}},"400":{"description":"Solicitação incorreta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Shared.Base.Models.Models.ErrorWrapper`1[[Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionErrorInfoModelResult, Orquestra.Models.Workflow, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Shared.Base.Models.Models.ErrorWrapper`1[[Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionErrorInfoModelResult, Orquestra.Models.Workflow, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Shared.Base.Models.Models.ErrorWrapper`1[[Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionErrorInfoModelResult, Orquestra.Models.Workflow, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"}}}},"401":{"description":"Pessoa não autorizada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}},"403":{"description":"Pessoa não tem permissão de executar essa operação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}},"404":{"description":"O registro não foi encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}},"429":{"description":"Muitas requisições em um determinado período de tempo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}},"500":{"description":"Ocorreu algum erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}}}}}},"components":{"schemas":{"Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionTransformedModelResult":{"type":"object","properties":{"success":{"description":"Lista de atributos retornados pela integração, transformados de acordo com os valores informados no mapeamento da integração.","type":"array","items":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionAttributeModelResult"}},"cache":{"description":"Indica se o valor da integração foi obtido do cache","type":"boolean"},"datasource":{"format":"int64","description":"Código identificador da integração","type":"integer"}}},"Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionAttributeModelResult":{"type":"object","properties":{"cod":{"description":"Código do atributo, obtido a partir do processamento do caminho do valor informado no mapeamento da integração","type":"string"},"txt":{"description":"Texto do atributo, obtido a partir do processamento do caminho do texto informado no mapeamento da integração","type":"string"},"fields":{"description":"Lista de campos, obtida a partir do processamento dos campos acessários informados no mapeamento da integração","type":"object","additionalProperties":{"type":"string"}}}},"Orquestra.Shared.Base.Models.Models.ErrorWrapper`1[[Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionErrorInfoModelResult, Orquestra.Models.Workflow, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionErrorInfoModelResult","description":"Objeto de erro"}}},"Orquestra.Models.Workflow.ApiModels.External._20.Integrations.IntegrationExecutionErrorInfoModelResult":{"type":"object","properties":{"errorMsg":{"description":"Mensagem que explica o motivo do erro ocorrido","type":"string"},"logCode":{"description":"Identificador do erro no log de erros do sistema","type":"string"},"friendlyMessage":{"description":"Mensagem de erro amigável obtida a partir do processamento do caminho da mensagem de erro informado no mapeamento da integração","type":"string"}}},"Orquestra.Models.Base.ApiModels.Suport.ErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.Error"}}},"Orquestra.Models.Base.ApiModels.Suport.Error":{"type":"object","properties":{"code":{"type":"string"},"key":{"type":"string"},"message":{"type":"string"},"vars":{"type":"array","items":{"type":"string"}},"details":{"type":"array","items":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.Error"}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://kb.stoque.com.br/zeev/apis/all/others/executeintegration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.