# Integração FTP (File Transfer Protocol)
## Configuração FTP
Para utilizar as funcionalidades de integração com FTP é necessário configurar uma variável de ambiente chamada "**ftpCredentials**". Essa variável deverá conter o seguinte json *encodado* em *base64.*
Por exemplo, se tivermos o seguinte json: {"server":"\","username":"\","password":"\"}
Deveremos configurar a variável de ambiente como: 'ftpCredentials=eyJzZXJ2ZXIiOiI8dXJsIHNlcnZpZG9yIGZ0cD4iLCJ1c2VybmFtZSI6Ijx1c3VhcmlvIGZ0cD4iLCJwYXNzd29yZCI6IjxzZW5oYSBmdHA+In0='
## CESS lendo do FTP
Para o CESS ler o arquivo original do FTP é necessário, além das configuração anterior, especificar duas chaves na criação da transação: "documents\_source" : "**FTP\_STORAGE**" e no documents\[] {**"data": "nome\_do\_objeto\_no\_repositorio\_ftp".**
Por exemplo, se deseja que seja assinado o arquivo chamado "meu\_arquivo.txt", então poderá utilizar o seguinte json como chamada:
```
{
"certificate_alias": "",
"type": "CAdEs-detached",
"hash_algorithm": "SHA256",
"documents_source": "FTP_STORAGE", //OBRIGATÓRIO
"policy": "AD_RB",
"checksum_algorithm": "SHA256",
"mode": "sync",
"documents": [
{
"id": "0",
"data": "meu_arquivo.txt", //OBRIGATÓRIO
}
]
}
```
## CESS escrevendo no FTP
Para o CESS escrever o arquivo assinado no FTP é necessário, além das configuração anterior, especificar duas chaves na criação da transação: "documents\_destination" : "**FTP\_STORAGE**" e no documents\[] {**"destination\_file\_name": "nome\_do\_objeto\_no\_repositorio\_ftp"** (opcional).
Por exemplo, se deseja que o arquivo assinado seja armazenado com o nome "minha\_assinatura.p7s", então poderá utilizar o seguinte json como chamada:
```
{
"certificate_alias": "",
"type": "CAdEs-detached",
"hash_algorithm": "SHA256",
"documents_source": "DATA_URL",
"documents_destination": "FTP_STORAGE", //OBRIGATÓRIO
"policy": "AD_RB",
"checksum_algorithm": "SHA256",
"mode": "sync",
"documents": [
{
"id": "0",
"data": "data:text/plain;base64,Y2xldWJlcl90ZXN0ZQ==",
"destination_file_name": "minha_assinatura.p7s" //OPCIONAL
}
]
}
```
**Observação**:
* Caso não seja definido um valor para variável "destination\_file\_name", será gerado um aleatório com a seguinte lei de formação: <*ano>***/**<*mês>***/**<*dia>***/**<*timestamp>***\_**<*numeroAleatório8Dígitos>.* Por exemplo: 2020/07/10/1594398391\_dc80d9b0.
* Quando cliente optar pelo documents\_*source* FTP\_STORAGE, deverá passar, caso queira especificar um nome para o objeto, o "destination\_file\_name" no mesmo nível do "id" e "data". Quando optar pelo UPLOAD\_REFERENCE, ele tem a opção de criar a chave "documents\[]" e passar o "id" e o "destination\_file\_name" no mesmo nível; pois quando realizar o upload via rota /file-transferer/\ ocorrerá o match entre o document\[id] e o id definido na chave "documents\[]' na criação da transação
---
# Agent Instructions: 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:
```
GET https://docs.vaultid.com.br/workspace/cess/api/integracao-ftp-file-transfer-protocol.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.