# Referência da Local API

A Local API da RPA de navegador é fornecida pelo cliente desktop MoreLogin V2.73.0 ou posterior em `http://127.0.0.1:<port>/api/rpa/browser/v1`. Use a porta da Local API exibida nas configurações do cliente; o padrão é `40000`.

A autenticação funciona da mesma forma que no restante da Local API; consulte [Autenticação](/pt/api-reference/getting-started/authentication). Envie corpos JSON com `Content-Type: application/json`. Uma resposta de sucesso é `{data,meta}` e uma resposta de erro é `{error,meta}`. As falhas de autenticação usam o formato 401 padrão da Local API. Trate as falhas com base no status HTTP, em `error.code`, em `details` e nos caminhos dos problemas, e não no texto da mensagem. [Convenções da API](/pt/browser-rpa/api/common) descreve todas as regras.

## Diretório de endpoints

### Recursos e nós

| Operação | Método e caminho relativo |
|  --- | --- |
| [Obter recursos](/pt/browser-rpa/api/get-capabilities) | `GET /capabilities` |
| [Listar tipos de nó](/pt/browser-rpa/api/list-node-types) | `GET /node-types` |
| [Obter um contrato de nó](/pt/browser-rpa/api/get-node-type) | `GET /node-types/{nodeType}` |


### Validação de fluxos

| Operação | Método e caminho relativo |
|  --- | --- |
| [Validar um fluxo](/pt/browser-rpa/api/validate-workflow) | `POST /validations` |


### Modelos e edição de nós

| Operação | Método e caminho relativo |
|  --- | --- |
| [Listar modelos](/pt/browser-rpa/api/list-templates) | `GET /templates` |
| [Criar um modelo](/pt/browser-rpa/api/create-template) | `POST /templates` |
| [Obter um modelo](/pt/browser-rpa/api/get-template) | `GET /templates/{templateId}` |
| [Substituir um modelo](/pt/browser-rpa/api/replace-template) | `PUT /templates/{templateId}` |
| [Excluir um modelo](/pt/browser-rpa/api/delete-template) | `DELETE /templates/{templateId}` |
| [Copiar um modelo](/pt/browser-rpa/api/copy-template) | `POST /templates/{templateId}/copies` |
| [Listar nós do modelo](/pt/browser-rpa/api/list-template-nodes) | `GET /templates/{templateId}/nodes` |
| [Editar nós do modelo](/pt/browser-rpa/api/edit-template-nodes) | `POST /templates/{templateId}/node-edits` |


### Execuções e resultados

| Operação | Método e caminho relativo |
|  --- | --- |
| [Iniciar uma execução](/pt/browser-rpa/api/start-run) | `POST /runs` |
| [Listar execuções](/pt/browser-rpa/api/list-runs) | `GET /runs` |
| [Obter detalhes da execução](/pt/browser-rpa/api/get-run) | `GET /runs/{runId}` |
| [Cancelar uma execução](/pt/browser-rpa/api/cancel-run) | `POST /runs/{runId}/cancel` |
| [Listar execuções de nós](/pt/browser-rpa/api/list-run-nodes) | `GET /runs/{runId}/nodes` |
| [Listar artefatos da execução](/pt/browser-rpa/api/list-run-artifacts) | `GET /runs/{runId}/artifacts` |


### Recuperação de solicitações

| Operação | Método e caminho relativo |
|  --- | --- |
| [Obter um recibo de solicitação](/pt/browser-rpa/api/get-request-receipt) | `GET /requests/{key}` |


### Referência compartilhada

- [Convenções da API](/pt/browser-rpa/api/common)
- [Modelos de dados](/pt/browser-rpa/api/data-types)
- [Fluxo, variáveis e nós de estrutura](/pt/browser-rpa/api/workflow)
- [Códigos de erro](/pt/browser-rpa/api/error-codes)
- [Detalhes de erro e matriz de recuperação](/pt/browser-rpa/api/recovery)
- [Observação de execuções e recuperação de solicitações](/pt/browser-rpa/api/observation)


## Cabeçalhos obrigatórios para solicitações de gravação

| Operação | `Idempotency-Key` | `X-RPA-Catalog-Revision` | `If-Match` |
|  --- | --- | --- | --- |
| [Criar um modelo](/pt/browser-rpa/api/create-template) | Recomendado | Obrigatório | — |
| [Substituir um modelo](/pt/browser-rpa/api/replace-template) | Recomendado | Obrigatório | Obrigatório |
| [Excluir um modelo](/pt/browser-rpa/api/delete-template) | Recomendado | Não obrigatório | Obrigatório |
| [Copiar um modelo](/pt/browser-rpa/api/copy-template) | Recomendado | Obrigatório | Obrigatório: o ETag do modelo de origem |
| [Editar nós do modelo](/pt/browser-rpa/api/edit-template-nodes) | Recomendado | Obrigatório | Obrigatório |
| [Iniciar uma execução](/pt/browser-rpa/api/start-run) | Recomendado | Obrigatório | — |
| [Cancelar uma execução](/pt/browser-rpa/api/cancel-run) | Recomendado | Não obrigatório | — |


`Idempotency-Key` é opcional, mas, sem ele, uma nova tentativa após um tempo limite esgotado pode repetir a gravação. Gere um novo UUID para cada nova intenção de gravação e guarde-o junto com o método, o caminho, o corpo e o `If-Match` até saber o resultado. `If-Match` recebe exatamente o `ETag` retornado por [Obter um modelo](/pt/browser-rpa/api/get-template). `X-RPA-Catalog-Revision` recebe o `data.catalogRevision` de [Obter recursos](/pt/browser-rpa/api/get-capabilities). [Validar um fluxo](/pt/browser-rpa/api/validate-workflow) é somente leitura, não precisa de nenhum desses cabeçalhos e não deixa recibo de solicitação.

## Contrato local legível por máquina

Leia `/openapi.json` na URL base local para obter o contrato HTTP. A URL do esquema do fluxo está em `data.docs.schema`, na resposta de `GET /capabilities`.

## Editar um modelo existente

Leia a versão mais recente do modelo e os contratos dos nós que você vai editar. Para alterações pontuais, aplique as edições de nó propostas à árvore completa e valide com `purpose:"save"`, `source.kind:"inline"` e `source.base:{templateId,version}`. Depois que o candidato passar na validação, envie as operações com `node-edits`. Um lote salva uma única nova versão ou não altera nada. Envie nós e blocos completos ao substituí-los e corrija as referências ao remover nós. Use PUT para substituir o modelo inteiro. Registre as dependências de modelos filhos com o `{processId,revisionId}` atual de cada uma e leia as dependências novamente após um conflito de versão.

## Recuperação

| Situação | Próximo passo |
|  --- | --- |
| Tempo limite na gravação, perda de conexão ou resultado incerto | Consulte `GET /requests/{originalKey}`. Para `completed`, use o resultado original; se o que foi concluído for o registro de uma execução, ainda é preciso verificar o status da execução. Para `accepted` ou `committed`, consulte novamente durante um tempo limitado. Para `unknown`, um 404 comum ou um recibo expirado, interrompa as gravações automáticas e verifique o recurso. |
| `RPA_REQUEST_NOT_COMMITTED` com `safeToRetrySameKey=true` | Repita a mesma intenção com a chave, o método, o caminho, o corpo e o `If-Match` originais, se houver. |
| Conflito de versão 412 | Verifique o recibo primeiro. Depois de confirmar que a gravação não foi efetivada, leia o modelo novamente, mescle as alterações, valide e envie com uma nova chave e o ETag atual. |
| Catálogo alterado | Verifique o recibo e confirme que a gravação não foi efetivada; depois, obtenha novamente os recursos e os contratos. Se o corpo e o `If-Match` continuarem iguais, atualize o cabeçalho do catálogo e mantenha a chave original. |
| `valid=false` ou um erro de entrada determinístico | Corrija o caminho indicado e valide novamente. Se a gravação tiver sido registrada como falha, confirme que nada foi efetivado antes de usar uma nova chave. Em respostas 429 ou 503, siga o `Retry-After` e as regras do recibo. |


Para executar um modelo salvo, consulte [Executar um modelo com a API](/pt/browser-rpa/run-api-example).