> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/developer-guide/pt-br/development-cycle/build-overview/capsulas/public-capsules/totvs-live.md).

# Totvs Live

{% hint style="info" %}
Para acessar a coleção Totvs Live e usar as funcionalidades presentes nesse artigo, você precisa ter a permissão PIPELINE:CREATE. Aprenda mais na [documentação sobre Papéis](/documentation/developer-guide/pt-br/platform-administration/administration/new-access-control/access-control-roles.md).
{% endhint %}

A coleção de cápsulas Totvs Live fornece recursos comumente utilizados em *pipelines* para tornar sua construção mais produtiva. Abaixo você pode conhecer mais sobre cada cápsula da coleção.

## Consultar Status Ticket

Esta cápsula encapsula a chamada do método ConsultarStatusTicketLC\_Integracao na API do Totvs Live.

### Parâmetros de configuração da cápsula

* **ws-live-url:** url da instância do Totvs Live.

### Entrada

```
{
    "chaveAcesso":"00000000-00000000-00000000-00000000",
    "codigoSistemaSatelite":"000000000",
    "numeroTicket": "0999999999999999",
    "manter":"qualquer valor que queira manter na saída do conector"
}
```

### Saída

#### Sucesso

```
{
    "encontrouRegistros": true|false,
    "status": 200,
    "processStatus": "ERROR|PROCESSING|SUCCESS",
    "items": [],
    "numeroTicket"
    "manter": "qualquer valor que tiver sido passado aqui será mantido"
}​
```

Regras de *Process Status*:

* Se algum item está aguardando processamento: PROCESSING
* Se algum item está com erro, ou foi processado mas está com mensagem de erro, e não há nenhum item em processamento: ERROR
* Se algum item foi processado com erro inexistente e não está em processamento: SUCCESS

#### Erro

```
{
    "timestamp": 1559243275088,
    "error": "Não foi possível consultar ticket.",
    "code": 500,
    "manter": "qualquer valor que tiver sido passado aqui será mantido"
}
```

## Recuperar Lojas

Esta cápsula encapsula a chamada do método RecuperarLojasLC\_Integracao\_Xml na API do Totvs Live.

### Parâmetros de configuração da cápsula

* **ws-live-url:** url da instância do Totvs Live.

### Entrada

```
{
    "retornaTodasLojas": "true",
    "chaveAcesso":"00000000-00000000-00000000-00000000",
    "codigoSistemaSatelite":"000000000",
    "manter" "qualquer valor que queira manter na saida do conector"
}
```

### Saída

#### Sucesso

```
{
    "encontrouRegistros": true,
    "status": 200,
    "data": 30052019,
    "hora": 191120,
    "codigoSistemaSatelite": 999999999,
    "numeroTicketSaida": 999999999999,
    "lojas": [],
    "manter": "qualquer valor que tiver sido passado aqui será mantido"
}
```

#### Erro

```
{
    "timestamp": 1559243275088,
    "error": "Não foi possível recuperar lojas.",
    "code": 500,
    "manter": "qualquer valor que tiver sido passado aqui será mantido"
}
```

## Recuperar Cliente

Esta cápsula encapsula a chamada do método RecuperarClienteLC\_Integracao na API do Totvs Live.

### Parâmetros de configuração da cápsula

* **ws-live-url:** url da instância do Totvs Live.

### Entrada

```
{
    "chaveAcesso":"00000000-00000000-00000000-00000000",
    "codigoSistemaSatelite":"000000000",
    "manter":"qualquer valor que queira manter na saida do conector"
}
```

### Saída

#### Sucesso

```
{
    "encontrouRegistros": false,
    "status": 200,
    "data": "5/30/2019",
    "hora": "4:04 PM",
    "numeroTicketSaida": 999999999999,
    "codigoSistemaSatelite": 999999999,
    "clientes": [],
    "manter": "qualquer valor que tiver sido passado aqui será mantido"
}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.digibee.com/documentation/developer-guide/pt-br/development-cycle/build-overview/capsulas/public-capsules/totvs-live.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.