# VISÃO GERAL

Esta documentação visa esclarecer todo o setup inicial da integração via arquivos em ambiente FTP.

Aqui abordamos os modelos de arquivos, layout, regras de negócio e considerações de cada um.

## PADRÕES DE INTEGRAÇÃO

### DIRETÓRIO E ARQUIVO

Iremos fornecer um ambiente FTP para que os arquivos sejam depositados, as regras abaixo servem para garantir que este fluxo tenha um funcionamento completo.

O servidor FTP fornecido utiliza SSH e será oferecido sem nenhum diretório criado. O template abaixo deve ser respeitado ao criarem os diretórios e, principalmente, o primeiro diretório (resource) e a extensão do arquivo, que deve ser csv.

```
TEMPLATE: <import|export>/<resource>/<year>/<month>/<day>/<time>.csv
```

```
EXEMPLO: import/origens/2021/05/10/123200.csv
```

O primeiro diretório deve ser **import** ou **export.** Sempre que a Souk receber um arquivo iremos observar o diretório de **import**.  \
Quando o arquivo for disponibilizado para ser consumido pela indústria parceira iremos depositar o arquivo no diretório **export**.

O segundo diretório **resources** deve ser preenchido com o tipo de integração: origens, produtos, logistica (sem acento), estoque e clientes.

O arquivo deve ser sempre CSV separados por vírgula e com aspas duplas como delimitador de colunas (quando necessário).

Recomendamos que utilizem a estrutura de diretórios como no template acima para facilitar monitoramento e log das informações.\
O primeiro diretório e o arquivo formatado da maneira correta são obrigatórios, os demais diretórios (mês/dia) e o nome do arquivo são opcionais.

## REGRAS DE LEITURA DOS ARQUIVOS

* Caso o CODIGO do arquivo se repita iremos considerar a última linha no arquivo.
* Deve ser respeitado o padrão de ordem das colunas, tipo de conteúdo e formatação.
* O **título das colunas** deve ser respeitado, caso haja diferença iremos parar o processo do arquivo.
* O conteúdo de cada coluna será forçado para o tipo definido, quando isto não for possível iremos parar o processo do arquivo. Veja a seção  **LAYOUT DO ARQUIVO** nas próximas explicações.
* O formato do conteúdo de cada coluna deve ser respeitado, quando não estiverem no formato correto todo o arquivo será ignorado.
* A codificação dos arquivos deve ser UTF-8.

## ORDEM DOS ARQUIVOS

Os arquivos que fazem a carga de dados na Souk: CLIENTES, ORIGENS, PRODUTOS, LOGISTICA e ESTOQUE devem obedecer uma ordem de upload quando depositados no ambiente FTP.

{% hint style="info" %}
**PRODUTO e ORIGENS antes de ESTOQUE.**
{% endhint %}

{% hint style="info" %}
**CLIENTE e ORIGENS antes de LOGÍSTICA.**
{% endhint %}

## FLUXO MACRO

![](https://3948253674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LUAz542zOLtyXMFatfP%2Fuploads%2Fsyp5vgcftXOTPTDyjnUO%2FFLUXO%20MACRO%20SOUK.png?alt=media\&token=065167de-0a9d-4277-9d4e-a481fa93542b)

Caso dúvidas entrar em contato via e-mail: [contato@souk.com.br](mailto:%20contato@souk.com.br)

<https://souk.com.br>