---
title: "Utilitário cliente do Rest PKI"
description: "Utilitário cliente do Rest PKI (rpkitool): aplicativo de linha de comando para assinar documentos em desktop, com configuração de endpoint e chave de API."
canonical: "https://docs.lacunasoftware.com/articles/rest-pki/core/integration/client-tool"
locale: "pt-BR"
product: "Rest PKI Core"
last_updated: "2026-07-22"
---

# Utilitário cliente do Rest PKI

O **utilitário cliente do Rest PKI** é um aplicativo de linha de comando para assinar documentos, entre outras operações, em aplicativos desktop utilizando o 
[Rest PKI Core](https://docs.lacunasoftware.com/articles/rest-pki/core). Por exemplo, para assinar um PDF:

```sh
rpkitool document.pdf --cert-cpf 11111111111 --overwrite
```

O utilitário consiste em um único arquivo executável que pode ser obtido em:

**[Rest PKI Client Tool for Windows](https://cdn.lacunasoftware.com/restpkicore/client-tool/win-x86/rpkitool.exe)**

Para outras plataformas, [clique aqui](https://cdn.lacunasoftware.com/restpkicore/client-tool/).

## Configuração

Para utilizar o utilitário, é preciso configurar o endereço da instância do Rest PKI Core (o *endpoint*) e a chave de API. Esses parâmetros podem ser configurados
por variáveis de ambiente ou por parâmetros para o comando.

Configuração com variáveis de ambiente `RestPki__Endpoint` e `RestPki__ApiKey`:

```plaintext
RestPki__Endpoint=https://restpki.yourcompany.com/
RestPki__ApiKey=YOUR_API_KEY
```

Configuração com parâmetros `--endpoint` e `--api-key`:

```sh
rpkitool ... --endpoint https://restpki.yourcompany.com/ --api-key YOUR_API_KEY
```

> **Observação**
>
> As chaves de API do Rest PKI Core geralmente contém um caractere de barra vertical (`|`), por exemplo `yourapp|12345678` (porém mais longo). Se isso constituir
> um problema para o seu caso, você pode utilizar apenas a parte após a barra vertical (no exemplo anterior, apenas `12345678`).

### Configurações opcionais

O timeout padrão nas chamadas ao Rest PKI Core é de 5 minutos. Pode ser necessário aumentar esse tempo se você estiver tentando assinar arquivos muito grandes
ou em situações de conexão lenta com a internet. Essa configuração pode ser alterada com a variável de ambiente `RestPki__TimeoutSeconds`:

```plaintext
RestPki__TimeoutSeconds=600
```

Ou com o parâmetro `--timeout`:

```sh
rpkitool ... --timeout 600
```

Os exemplos acima configurariam o timeout para 10 minutos (600 segundos).

## Comandos

Cada operação que pode ser realizada com o utilitário é chamada de um **comando**. Os seguintes comandos estão disponíveis:

* [sign](https://docs.lacunasoftware.com/articles/rest-pki/core/integration/client-tool/sign) - Assina um documento utilizando um dos certificados do usuário
* [list-certs](https://docs.lacunasoftware.com/articles/rest-pki/core/integration/client-tool/list-certs) - Lista os certificados presentes no repositório de certificados do usuário
* [allocate-keys](https://docs.lacunasoftware.com/articles/rest-pki/core/integration/client-tool/allocate-keys) - Reserva chaves de validação de documentos

## Saída / códigos de retorno

Se o comando for bem sucedido, o código de retorno será `0` e qualquer saída será escrita para o `stdout`.

Caso ocorra um erro, o código de retorno será `>= 1` e informações sobre o erro serão escritas para o `stderr`. Veja abaixo a lista de códigos de retorno.

Exit code | Description
--------- | -----------
0         | Success
1         | Unspecified error
2         | Bad syntax
3         | Missing API parameters
4         | File not found
5         | Unacceptable filename
6         | File rejected
7         | Certificate not specified
8         | Certificate not found
9         | Certificate rejected
10        | Bad `--count` argument
12        | Rest PKI API exception

## Logs

Por padrão, os arquivos de log são escritos para:

* Em Windows: `%LOCALAPPDATA%\Lacuna Software\Rest PKI Tool\Logs` (ex: *C:\Users\USERNAME\AppData\Local\Lacuna Software\Rest PKI Tool\Logs*)
* Em Linux: `~/.local/share/rpkitool/logs` (ex: */home/USERNAME/.local/share/rpkitool/logs*)

A variável de ambiente `Serilog__WriteToPath` pode ser usada para alterar a pasta na qual os logs são escritos.

Por padrão, apenas logs de severidade `Warning` ou superior são escritos. A variável de ambiente `Serilog__MinimumLevel__Default` pode ser usada para alterar esse
comportamento. Os níveis de severidade, do menos severo para o mais severo, são:

* `Verbose`
* `Debug`
* `Information`
* `Warning`
* `Error`
* `Fatal`