# Integrações



# ADVWIN+ - Integração Intimação

**PASSO A PASSO**

**INTEGRAÇÃO ADVWIN+**

#### **REQUISITOS**

1. Gerar chave API no painel da Oystr;
2. Solicitar webhook (URL) e idcliente para TWT.

#### **OYSTR**

<span id="bkmrk--1" style="font-weight: normal;"></span>

1. Primeiro passo é acessar o console da Oystr com seu login e senha;
2. Clique no e-mail disposto no canto superior esquerdo, em seguida clique em Configurações API e crie uma nova chave;
3. Copiar a chave API e enviar para TWT.

![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/XQFimage.png)

sObs.: no caso do exemplo a chave já foi criada.

##### **APP DE INTIMAÇÕES**

Coloque o cursor no ícone Apps e clique em Intimações &gt; Perfis &gt; Configurações:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/yLDimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/yLDimage.png)

Insira as informações na tela abaixo:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/ES8image.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/ES8image.png)

1. Em WebHook preencher: http://api.twtinfo.com.br/cnj/oystr/intimations
2. Em JSON Header WebHook: {"idclientetwt":x,"idcliente":y}
1. Obs.: Solicitar idcliente para TWT.

4. Não precisa preencher os outros campos;
5. Após preenchimento, clicar em SALVAR;
6. Notificar CS/time de desenvolvimento para aplicar configurações internamente.

**Com isso, a integração estará ativada e você poderá importar todas as intimações executadas pelo robô no Advwin+.**

#### **ADVWIN+**

**Acessando o Módulo de Importação de Intimações no ADVWIN+**

O Módulo de Importação de Intimações no ADVWIN+ é acessado pelo caminho: Menus &gt; Integrações &gt; Intimações.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/jU7image.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/jU7image.png)

#### Tela Inicial

Na página inicial é possível visualizar e acessar informações:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/33Bimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/33Bimage.png)

1. Intimações que foram importadas para o ADVWIN+, dentro do módulo de intimações, mas que não foram tratadas. O painel mostra três níveis: Intimações importadas e não tratadas nos últimos 15 dias, nos últimos 30 dias e em todo o período;
2. Clicando no botão “mostrar” é aberta a tela de tratamento das intimações.
3. Acesso a tela de usuário e senha para a importação de novas Intimações.
4. Abre a tela de pesquisa, sendo possível pesquisar por diferentes parâmetros.

#### Importar Intimação

Ao selecionar “Importar Intimação” abrirá a tela para a importação de Intimações:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/4Taimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/4Taimage.png)

1. Preencher usuário e senha. As credenciais são fornecidas pela TWTInfo. Para mais informações entre em contato com a equipe comercial.
1. Caso não tenha as credenciais ou estejam incorretas a seguinte mensagem será apresentada:

3. Selecionar importar as intimações já importadas.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/5Hkimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/5Hkimage.png)

2. 1. Inserir as datas de Intimação de Início e Fim e clicar em “Importar” (5).
    2. O usuário tem a opção de marcar para importar as publicações já importadas. Dessa forma buscará no webservice da Oystr as publicações já importadas. Ao importar novamente o ADVWIN+ apresentará o status de tratamento realizado anteriormente. Por exemplo: a intimação foi importada e ignorada. Se importada novamente será listada como ignorada.
    3. Para publicações já importadas no ADVWIN+ sugerimos usar o Pesquisar.

3. Selecionar e clicar em “Importar” (5) para importação de novas intimações pendentes na Oystr.
4. Salvar o usuário e senha por usuário logado. Se outro usuário acessar o ADVWIN+ deverá inserir as credenciais.
5. Após preencher e selecionar as informações anteriores, clique em “Importar”.

#### **Tratamento de Intimações**

Tanto por pesquisas, quanto por mostrar pendentes ou ao importar novas intimações, o usuário será direcionado para a tela abaixo:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/ebNimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/ebNimage.png)

##### **Pesquisar**

Em qualquer etapa da Importação de Intimações o botão “Pesquisar” está disponível em tela.

Para executar uma pesquisa: Selecione o Módulo (A) &gt; O Campo que deseja a informação (B) &gt; e/ou Valor desse campo (C) &gt;Clique em “+” para estabelecer as condições da pesquisa (D) &gt; Clique em pesquisar (E).

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/HtVimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/HtVimage.png)

##### **Compacto**

Com o Compacto desativado é possível visualizar as informações do texto das intimações na parte inferior da tela. Sendo possível aumentar ou diminuir o tamanho da fonte e expandir o texto.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/mNNimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/mNNimage.png)

Com o Compacto acionado, a tela é dividida ao meio e as informações do texto da Intimação passa para o lado direito da tela. Sendo possível aumentar ou diminuir o tamanho da fonte e expandir o texto.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/Gzlimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/Gzlimage.png)

##### **Grid**

A – Customizar Colunas do Grid (Setas Opostas) – o usuário poderá selecionar e posicionar as informações.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/e7Dimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/e7Dimage.png)

Ao lado esquerdo estão os campos visíveis no Grid e ao lado direito os campos disponíveis para inserir no Grid.

Selecione o campo e clique na seta azul para incluir e na seta vermelha para retirar o campo do Grid.

Arraste os campos selecionados para cima ou para baixo para posicioná-los.

Clique no botão salvar para manter o posicionamento escolhido.

B – Atualizar Grid – Atualiza as informações do Grid (conforme pesquisa aplicada), incluindo ou retirando linhas de informações de intimações.

C – Funil – realiza filtros por seleção.

D – Realiza filtros digitando as informações que busca do Grid.

E – Possibilidade de arrastar uma ou mais colunas e realizar um agrupamento de informações.

#####  **Identificação do Status**

No Grid é possível identificar o Status da Intimação por meio dos ícones na segunda coluna ou adicionando a coluna status.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/xuyimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/xuyimage.png)

![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/G3bimage.png)

##### **Opções de Tratamento de Intimações**

Na parte inferior da tela estão as opções de tratamento das intimações e visualização de informações e anexos.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/Rt9image.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/Rt9image.png)

1. Cadastrar Pasta – é possível cadastrar uma nova pasta, diretamente da intimação selecionada. A Intimação que estava com o status “Sem Pasta Cadastrada” passa a aparecer “Pasta Cadastrada” e será possível inserir as informações na movimentação.
2. Importar Intimação – cadastra a intimação em movimentação da pasta e insere o documento no Ged na movimentação correspondente. A Importação poderá ser realizada de duas formas:  
    
    1. Clique no botão “Importar Intimação” para inserir automaticamente a movimentação com o documento anexo. O nome/tipo da movimentação será o determinado como padrão.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/4uEimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/4uEimage.png)

Para determinar o padrão do tipo de movimentação, o Administrador do sistema Advwin (desktop) deverá seguir os seguintes passos:

1. 1. 1. Acessar o caminho: Arquivos &gt; K Parâmetros &gt; Novos Parâmetros.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/mMtimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/mMtimage.png)

1. 1. 1. Na Tela de Parâmetros do Sistema pesquise por intimação (A), marque como verdadeiro (B), insira o código da movimentação que será utilizada como padrão (C) e clique em Salvar (D).

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/suaimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/suaimage.png)

1. 1. Clicando na seta ao lado do botão é possível selecionar o nome/tipo de movimentação e a decisão.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/1NGimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/1NGimage.png)

A intimação será inserida na movimentação e decisão selecionadas com os documentos anexos.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/t5yimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/t5yimage.png)

1. Ignorar Intimação – Ignora a intimação selecionada em tela.
2. Desprezar Processo – ATENÇÃO – não serão apresentadas novas intimações do processo desprezado. Despreza o processo da intimação selecionada em tela. Novas intimações desse processo serão tratadas com o status “Desprezadas”.

Sempre que uma pasta inativa cujo número de processo tiver sido desprezado, for reativada ou quando for criada uma pasta com número de processo já desprezada, o ADVWIN+ irá identificar e excluir aquele número da lista de desprezados, possibilitando a importação da intimação normalmente.

1. Novo Prazo – desde que a intimação selecionada tenha uma pasta cadastrada, é possível inserir um novo prazo na pasta diretamente dessa tela.
2. Anexos – Abre o(s) anexo(s) da intimação selecionada para visualização.
3. Abre informações da intimação em uma tela expandida.

##### **Card**

O card é uma outra forma de visualizar e tratar as intimações. Nesse layout não é possível o tratamento em lote.

 ec ullamcorper mattis, pulvinar dapibus leo.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/YQqimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/YQqimage.png)

No card é possível visualizar as informações e tratar as intimações.

No alto e início da tela temos três botões:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/SuQimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/SuQimage.png)

- Pesquisar – explicação no item 5.1.
- Voltar – retorna a página
- Quantidade de intimações em tela.

Sempre que o tratamento de intimações for realizado nessa tela, aparecem ícones com as quantidades e o tratamento realizado. Ao clicar nesses ícones é possível visualizar as intimações tratadas:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/eHvimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/eHvimage.png)

No exemplo temos duas intimações ignoradas (cor laranja conforme o botão ignorar intimação) e uma intimação desprezada (cor verde conforme o botão desprezar processo).

Para retornar ao estado anterior basta clicar na opção “Remover Ignorado” ou “Remover Desprezado”.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/obpimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/obpimage.png)

#### **DÚVIDAS?** 

Dúvidas, sugestões ou relatos de erros contidos neste documento, não deixe de informar nossas equipes de suporte:

**Suporte Oystr**  
E- mail: <suporte@oystr.com.br> ou pelo chat no canto inferior direito do painel.

**Suporte TWT**  
E-mail: <suporte@twtinfo.com.br>

# AUTOJUR - Integração Intimação

**PASSO A PASSO**

**INTEGRAÇÃO AUTOJUR**

#### **REQUISITOS**  


1. Gerar chave API no painel da Oystr e cadastrar no AUTOJUR;
2. Gerar a Chave-credencial e a URL no AUTOJUR e enviar para a equipe da Oystr.

#### **PASSO 1 - OYSTR** 

1. Primeiro passo é acessar o console da Oystr com seu login e senha;
2. Clique no e-mail disposto no canto superior esquerdo, em seguida clique em **Configurações** API e crie uma nova chave;

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/zWqimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/zWqimage.png)

3. **Copiar** a chave API e enviar para AUTOJUR.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/KPlimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/KPlimage.png)


#### **PASSO 2 - AUTOJUR**

Após obter o token da Oystr é necessário cadastrar uma Credencial no AUTOJUR utilizando ele.

Para ter acesso à criação e gerenciamento da Credencial, o perfil do usuário deve ter a permissão **Credencial** habilitada **(No Perfil do Usuário, a permissão Gerenciamento → Gestão do Sistema → Credencial deve estar marcada)**.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/BWIimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/BWIimage.png)

1. No AUTOJUR, acesse o menu **Principal → Gerenciamento → Gestão do Sistema → opção Credencial.**
2. Será exibida a lista com as existentes. Clique no botão **Adicionar**.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/98Mimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/98Mimage.png)

3. Informe um nome para a Credencial (pode escrever “Oystr”). No campo **“Tipo”**, selecione a opção **“Captura de Informação”**. Por fim, no campo **“Empresa”**, selecione a opção **“Oystr”**. Se este campo não mostrar nenhuma opção, certifique-se de ter selecionado a opção correta no campo **“Tipo”**.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/kfHimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/kfHimage.png)

4. As demais informações que devem ser configuradas serão exibidas, como mostra a imagem a seguir.   
    Observe que o campo “Processar Automaticamente” deve ser ajustado como ‘Sim’. Depois, o campo “Usuário Processamento” será habilitado para a escolha de uma opção. Selecione o Usuário (só é possível selecionar um) que receberá as publicações enviadas pela Oystr. As publicações serão enviadas direto para o menu Principal → Agendamento → Classificar Informação. Depois que as Publicações forem disponibilizadas, o Usuário selecionado poderá distribuí-los a outros para que eles sigam com a classificação e lançamento das Tarefas.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/eyqimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/eyqimage.png)

A tabela a seguir descreve a função de cada campo:

<div align="left" dir="ltr" id="bkmrk-campo-descri%C3%87%C3%83o-nome"><table border="1" class="align-center" style="border-collapse: collapse; border-style: solid; border-width: 1px;"><colgroup><col width="181"></col><col width="489"></col></colgroup><tbody><tr><td>**CAMPO**

</td><td style="text-align: justify;">**DESCRIÇÃO**

</td></tr><tr style="text-align: justify;"><td>Nome

</td><td>Nome da credencial. No caso da integra

</td></tr><tr style="text-align: justify;"><td>Tipo

</td><td>Selecione a opção Captura de Informação.

</td></tr><tr style="text-align: justify;"><td>Empresa

</td><td>Selecione a opção Oystr.

</td></tr><tr style="text-align: justify;"><td>Hash/Número/

Credencial/

E-mail

</td><td>Insira o token gerado na plataforma da Oystr, conforme descrito na seção Contratação do serviço com a Oystr e obtendo o token de autenticação.

</td></tr><tr style="text-align: justify;"><td>Tipo de Documento

</td><td>É o Tipo de Documento que será selecionado nos anexos das publicações, caso tenham. Se o Tipo de Documento desejado não é exibido nessa lista, cancele o cadastro da Credencial, acesse a lista de Tipos de Documentos, procure ou cadastre o tipo desejado, caso não tenha. Acesse o guia [Como Cadastrar e Gerenciar Tipo de Documento](https://sites.google.com/perceptvision.com.br/wikipercept/autojur/cadastros/aj-como-cadastrar-e-gerenciar-tipo-de-documento) para mais informações.

</td></tr><tr style="text-align: justify;"><td>Data Início Contagem

  
</td><td>Data de Início de Contagem que será aplicada nas publicações. É a partir desta data que o AUTOJUR calcula o Prazo Final das Tarefas.

Você pode selecionar duas opções:

1. Data de Disponibilização: data em que a publicação foi disponibilizada.
2. Data atual: data que a publicação foi recebida no AUTOJUR.

</td></tr><tr style="text-align: justify;"><td>URL da integração

</td><td>Endereço do ambiente AUTOJUR que irá receber as publicações. Este endereço deve ser informado à equipe da Oystr para que a configuração seja concluída.

</td></tr><tr style="text-align: justify;"><td>Processar Automaticamente

</td><td>Indica se as publicações devem ser processadas automaticamente, sendo enviadas direto para o menu Classificar Informação. No caso da integração com o serviço de captura de intimações da Oystr, esta opção sempre deve ser marcada como “Sim”.

</td></tr><tr style="text-align: justify;"><td>Usuário Processamento

</td><td>É o Usuário que receberá as publicações processadas automaticamente.

  
Vale lembrar que este Usuário poderá distribuí-las para outros para que estes realizem a classificação, geração de Tarefas e façam o lançamento.

</td></tr><tr style="text-align: justify;"><td>Ativo

</td><td>Indica se a credencial está em uso ou não.

</td></tr><tr><td style="text-align: justify;">Homologação

</td><td>No caso da integração com a Oystr, este campo estará desabilitado para edição.

</td></tr></tbody></table>

</div>Por fim, clique no botão **Salvar**.

**Após salvar o cadastro da Credencial no AUTOJUR, é necessário enviar duas informações para a equipe de suporte da Oystr:**

1. Chave-credencial;
2. **URL do AUTOJUR.**

Para obtê-las, edite a Credencial criada. A imagem a seguir mostra onde você encontra essas informações.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/FqUimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/FqUimage.png)

<p class="callout warning">**ATENÇÃO: a URL mostrada na imagem é apenas um exemplo. Portanto não copie essa informação da imagem. Cada ambiente AUTOJUR possui uma URL diferente. Verifique a que é exibida no seu ambiente.**</p>

Envie estas informações para o CS de Implantação responsável da Oystr por e-mail para finalizar a configuração da integração.


#### **PASSO 3 - AUTOJUR** 

**Onde as publicações são recebidas?**

Após a Oystr confirmar o término da configuração, as publicações serão enviadas direto para o menu Principal → **Agendamento → Classificar Informação**.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/rnUimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/rnUimage.png)

Caso você receba publicações de outras fontes, é possível filtrar apenas as que são recebidas pela Oystr, como mostra a imagem a seguir.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/2nbimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/2nbimage.png)

#### **DÚVIDAS?**

Dúvidas, sugestões ou relatos de erros contidos neste documento, não deixe de informar nossas equipes de suporte:

**Suporte Oystr**  
E- mail: <suporte@oystr.com.br> ou pelo chat no canto inferior direito do painel.

**Suporte Autojur**  
E-mail: <conteudo@perceptvision.com.br>

# CPJ - Integração Protocolos

**PASSO A PASSO**   
**INTEGRAÇÃO CPJ**   
**PROTOCOLOS**

<p class="callout warning">**Não compartilhar este documento com o cliente ou qualquer empresa, sem prévia autorização do time de parcerias ou da diretoria. Este documento é exclusivo para uso interno e orientações assertivas quanto à integração.** </p>

#### **Comercial**

1. Integração com o App de Protocolos;
2. Notificar da necessidade do Certificado A1 para realização dos protocolos.
3. Notificar o cliente sobre a versão do CPJ (CPJ-H - Versão homologação H03.71).
4. Avisar o cliente sobre a planilha de equivalências.
1. Orientar o cliente a utilizar a planilha padrão de equivalências, o que facilita e diminui o tempo de setup da integração. (Preâmbulo já possui nossa planilha padrão)

6. Orientar o cliente a entrar em contato com a Preâmbulo para avisar sobre a contratação de protocolos conosco.
1. É necessário configurar o ambiente API-CPJ.


#### **CS - Implantação**

##### **Kick-off:**

- Alinhamento da contratação;
- Mapear os tribunais/sistemas que vão utilizar;
- Salvar credencial no vault (pág. 3);
- Iniciar a configuração das equivalências.

**Treinamento:**

- Reunião de teste assistido (Oystr + Preâmbulo);
- Após teste existem dois caminhos:
1. Cliente começa a utilizar;
2. Treinamento da Preâmbulo com a equipe do escritório.

- Acompanhar por 1 semana. Após, fazer passagem de bastão para CS (Ongoing).

#### **Requisitos**

##### ****Advogado deve ter o certificado A1****

Os robôs não comportam certificados do tipo A3.

Caso o advogado não tenha o certificado A1 indicamos adquirir o e-CPF da [Certisign](https://loja.certisign.com.br/certificado/e-cpf), sem ele não é possível realizar testes (apenas em sistemas que comportam assinatura externa).

Indicamos a Certisign, pois outras certificadoras podem não funcionar. Caso o advogado já possua certificado A1 de outra certificadora, é recomendado realizar o teste antes de indicar adquirir o certificado da Certisign.

O cliente deve ter acesso ao arquivo .pfx do [certificado exportado](https://wiki.oystr.com.br/books/tutoriais/page/instalando-e-exportando-certificado-a1) para gravar no cofre.

##### **Clientes que queiram a integração**

<span style="text-decoration: underline;">Manifestação de Interesse</span>

Quando o cliente manifestar o interesse em adquirir o robô de protocolos integrados com o CPJ, temos alguns passos que devem ser seguidos:

Sugiro sempre perguntar qual a versão do CPJ do cliente (funciona apenas na versão H). Caso não esteja na versão H, identificar se há previsão.

O cliente precisa enviar um e-mail para **Jhenifer Machado** (jhenifer.machado@preambulo.com.br) e **Raphael Chagas** (raphael.chagas@preambulo.com.br) e o CS da conta solicitando a preparação do ambiente.


#### **Preâmbulo**

<span style="text-decoration: underline;">Ações</span>:

- Atualizar a versão de homologação do cliente para a versão H03.71;
- Auxiliar o cliente no cadastro dos casos de testes ;
- Cadastrar as equivalências dos documentos internamente no CPJ com os códigos da API ;
- Configurar o Login e Senha do painel Oystr do cliente na API;
- Enviar a Descrição do evento (caso seja o formato), [código dos documentos](https://docs.google.com/spreadsheets/d/1_KWNxXMrp7ZbKWdr2LGtzByLa9FfpteCZTAjHA_ntig/edit#gid=0), e sistema a serem testados para configuração das equivalências no painel do cliente na Oystr.

#### **Oystr**  


<span style="text-decoration: underline;">Ações:</span>

- Ativar o app de protocolos na conta do cliente;
- Enviar o login e senha do painel do cliente para o time Preâmbulo;
- Orientar o cliente a [cadastrar as credenciais no Vault](https://wiki.oystr.com.br/books/tutoriais/page/cadastro-credencial-vault) vinculando o CPF do advogado a credencial, caso queira validar verificar próximo passo;
- [Vincular CPF a credencial salva no vault](https://console4.oystr.com.br/protocols/configuration);
- [Cadastrar as equivalências](https://docs.google.com/spreadsheets/d/1_KWNxXMrp7ZbKWdr2LGtzByLa9FfpteCZTAjHA_ntig/edit?usp=sharing) de Tipo de Protocolo e Documento nos respectivos sistemas a serem testados Informações padrões.

<span style="text-decoration: underline;">No cadastro do Vault:</span>

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 100%; height: 200.227px;"><colgroup><col style="width: 28.4512%;"></col><col style="width: 71.6611%;"></col></colgroup><tbody><tr style="height: 200.227px;"><td style="height: 200.227px;">[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/JQlimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/JQlimage.png)

</td><td style="height: 200.227px;">[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/VFWimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/VFWimage.png)

</td></tr></tbody></table>

<span style="text-decoration: underline;">No cadastro do Vault antes de salvar, vincular CPF:</span>

<table border="1" id="bkmrk--1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50.0562%;"></col><col style="width: 50.0562%;"></col></colgroup><tbody><tr><td>[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/0oqimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/0oqimage.png)

</td><td>[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/mZ2image.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/mZ2image.png)

</td></tr></tbody></table>

<span style="text-decoration: underline;">[CPF vinculados as credenciais:](https://console4.oystr.com.br/protocols/configuration)</span>

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/lgQimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/lgQimage.png)

<span style="text-decoration: underline;">Equivalências:</span>

O cliente poderá usar o padrão da Oystr ou criar as suas equivalências (Pode editar o padrão também).<span style="text-decoration: underline;">  
</span>

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/HWRimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/HWRimage.png)

<span style="text-decoration: underline;">Informações padrões:</span>

- EPROC - Perfil padrão para protocolo (exemplo: PR025612/ADVOGADO);
- Tipo de Protocolo pela descrição do evento ou tipo arquivo;
- Cumprir apenas uma intimação ou todas.

<p class="callout info">É possível definir outras informações fixas no robô a depender do campo, em contas específicas através do back-end (sem tela)</p>

- [https://console4.oystr.com.br/settings](https://console4.oystr.com.br/settings)

<table border="1" id="bkmrk--4" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/CJ1image.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/CJ1image.png)

</td><td>[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/iduimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/iduimage.png)

</td></tr></tbody></table>

#### **Realizando o Protocolo**

Passo a passo

<span style="text-decoration: underline;">Agenda do CPJ</span>

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/aEGimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/aEGimage.png)

<span style="text-decoration: underline;">Contratação</span>

1. Contratar serviço de terceiro:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/KXXimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/KXXimage.png)

2. Inserir informações:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/o6wimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/o6wimage.png)

3. <span style="text-decoration: underline;">É importante que o CPF do responsável pela assinatura esteja preenchido.</span>

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/6gHimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/6gHimage.png)

4. Clique em Verificar:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/Hlnimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/Hlnimage.png)

<p class="callout info">Após clicar em verificar, o sistema consulta se o protocolo já foi realizado.  
</p>

5. Na tela da Agenda é possível acompanhar os status das contratações.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/LEvimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/LEvimage.png)

6. Em caso de erro a barra lateral fica vermelha:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/LYBimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/LYBimage.png)

<p class="callout info">O motivo do erro aparece em Justificativa.  
  
[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/mMBimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/mMBimage.png)  
</p>

7. Para acompanhar o protocolo no painel de controle, basta acessar o App de protocolos &gt; Protocolos:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/Dshimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/Dshimage.png)

#### **Links importantes**

- Exportar lista de tipos de protocolos e tipos de documentos do oracle: [link](http://dev.oystr.com.br/api/oracle/v1/tipos/exportar)
- Json com a lista de documentos da API do CPJ: [link](https://api.preambulo.com.br/api/v1/documentos/tipos?cache=true)
- Converter Json em Excel: [link](https://www.gigasheet.com/post/import-json-to-excel)
- Lista de equivalências padrões Oystr: [link](https://docs.google.com/spreadsheets/d/1fz_YDTcJfR2ZsSVJ3Cv8yKcwSXI9KZGzgbdicEeJOEE/edit#gid=0)

#### **Pontos de atenção**

- A API de protocolos terá custo adicional para o cliente junto á **Preâmbulo**.
- Há um custo de setup do lado da **Oystr** (atenção se o cliente irá realizar o upgrade dos protocolos no painel para API).
- Por enquanto, não existe a possibilidade de cumprir protocolos específicos por enquanto.
- Por enquanto, não existe a possibilidade de vincular nº de guias em protocolos.
- A tela de perfis não está separada por sistemas, sugiro passar a lista e subir pelo back.

#### **DÚVIDAS?**

Dúvidas, sugestões ou relatos de erros contidos neste documento, não deixe de informar nossas equipes de suporte:

**Suporte Oystr**  
E- mail: <suporte@oystr.com.br> ou pelo chat no canto inferior direito do painel.

**RPA**  
Luan Melo - <luan.melo@oystr.com.br>

**App de Protocolos**  
Andrews Angeli - <andrews.angeli@oystr.com.br>   
Adelon Silva - <adelon.silva@oystr.com.br>

**Integrador**  
Leandro Cruz - <leandro@oystr.com.br>

**Oráculo**  
Andrews Angeli - <andrews.angeli@oystr.com.br>   
Gustavo Inkotte - <gustavo.inkotte@oystr.com.br>

  
**Suporte Preâmbulo**  
E-mail: <help.desk@preambulo.com.br>

# TECNOJURIS - Integração

#### **PASSO A PASSO**

**INTEGRAÇÃO TECNOJURIS**

#### **TECNOJURIS**

O primeiro passo para a integração é acessar a tela de integração no tecnojuris indo em Admin &gt; Minha conta e acessar a aba de Credenciais de acesso.

Ao clicar em “+” daremos início as configurações de integração. Neste passo você precisa acessar o painel da Oystr para pegar a chave de acesso.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/vrNimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/vrNimage.png)

#### **OYSTR**

Para gerar a chave de acesso, você deverá ir em configurações, clicar em gerar chave de integração e copiar a chave gerada.

Caso a chave já esteja gerada, basta copiar a chave existente.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/Du1image.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/Du1image.png)

#### **TECNOJURIS**

Agora, voltando ao Tecnojuris, após clicar em “+” será aberta uma janela como abaixo, onde teremos que colar a chave copiada do painel da Oystr no campo designado e gravar.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/qGMimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/qGMimage.png)

#### **OYSTR**

Por fim retornaremos ao painel da Oystr e iremos acessar Apps &gt; Intimações, acessaremos a tela de perfis e clicamos em configurações.

Nesta tela iremos colar no campo Webhook, a URL de monitoramento disponibilizada no tecnojuris e, também, colaremos no campo JSON Header Webhook, a chave de autenticação disponibilizada no tecnojuris no seguinte formato:

```json
{"assinatura":"CHAVE_DE_ACESSO_TECNOJURIS"}
```

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/d6simage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/d6simage.png)

####  

#### **DÚVIDAS?**

Dúvidas, sugestões ou relatos de erros contidos neste documento, não deixe de informar nossas equipes de suporte:

**Suporte Oystr**

E- mail: <suporte@oystr.com.br> ou pelo chat no canto inferior direito do painel.

**Suporte Tecnojuris**

E-mail: <suporte@tecno2.com.br> ou pelo chat na canto inferior esquerdo do sistema.

Telefone: (11) 3564-0922

# LEGAL ONE - Integração Protocolos

**PASSO A PASSO**   
**INTEGRAÇÃO LEGAL ONE**  
**PROTOCOLOS**

#### ****Comercial****

1. Notificar da necessidade do Certificado A1 para realização dos protocolos.
2. Solicitar um acesso ao Legal One exclusivo para o uso do robô.
3. Alertar o cliente do preenchimento da planilha de equivalências.
1. O preenchimento é feito manualmente com os tipos de protocolos personalizados que o cliente possui dentro do L1.


#### **CS - Implantação**

##### ****Kick-off:****

- CS enviará documento de configuração ao solicitar o kick-off.
- Criação de usuário para o robô (se foi criado ou não);
- Planilha de equivalências ([Exemplo](https://docs.google.com/spreadsheets/d/11EEX0WXnAhYOXwrq92zmZNvTOwJVoST3/edit?usp=sharing&ouid=113051374792111526754&rtpof=true&sd=true));
- Mapear os tribunais/sistemas que vão utilizar.
- Explicar sobre a criação de campos personalizados (página 3).

##### **Treinamento**

- **Particularidades Sistemas**:
    
    
    - Criar campo de Perfil ou deixar default (padrão).
    
    - Em casos em que o advogado já se encontra habilitado no processo o campo PERFIL não é mais obrigatório mesmo que o advogado tenha mais de um perfil.
    
    - Criar campo para cumprir prazos/intimações.
    
    
    - Salvar no cofre: Usuário/Senha e Certificado A1.
    
    
    - Salvar no cofre: Usuário/Senha e Certificado A1.
    
    
    - Entender com o cliente qual o fluxo de protocolos. Ou seja, se o documento sempre estará assinado ou se vai mandar para o robô assinar.
    
    - Se o arquivo estiver assinado, salvar no cofre: Usuário/Senha ou Certificado A1.
    - Se o arquivo não estiver assinado, é obrigatório salvar o Certificado A1.
- **Eproc**:
- **Projudi PR**:
- **Projudi BA**:
- **TJ/RJ – Sistema Próprio**:


#### **Requisitos**

- Usuário e senha exclusivos para o integrador;
- Configurações de campos personalizados;
- Definir qual o tipo do arquivo do comprovante do protocolo no L1.

#### **Cadastro credencial**

<span style="text-decoration: underline;">Login e senha:</span>

- O cliente deve fornecer um login e senha para utilizarmos no robô.
- Note que este login e senha deve ser um acesso exclusivo para o robô. Isso acontece pois caso o robô esteja usando a conta e o cliente ou qualquer outra pessoa acessar, a sessão cai. Deste modo o robô retornará erro.

<span style="text-decoration: underline;">Cadastro vault:</span>

- O login e senha devem ser salvos em nosso Vault da seguinte maneira: Robô de listar tarefas “Thomson Legal One – Listar Tarefas”.
- Id do robô: **legalone-integracao-tarefa**.
- Para mais detalhes do vault [clique aqui](https://wiki.oystr.com.br/books/tutoriais/page/cadastro-credencial-vault).

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/CXtimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/CXtimage.png)

<span style="text-decoration: underline;">Hash:</span>

- A partir disso o pessoal da infra deve ser informado para que utilize essa credencial no integrador e o robô consiga funcionar.
- Importante lembrar que além de salvar o acesso do LegalOne em nosso cofre também é necessário que as credenciais necessárias para realizar o protocolo também estejam salvas.
- Ex: Quero um protocolo no esaj, a credencial que corresponde ao robô que realiza o protocolo no esaj deve estar salva em nosso Vault.

#### **Campos Personalizados – Como criar?**

1. Clicar em **opções** no canto superior direito:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/9U4image.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/9U4image.png)

2. Clicar no menu **Personalizações**:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/1tVimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/1tVimage.png)

3. Clicar no módulo que deseja criar o campo:
    
    
    1. Agenda &gt; Compromissos e tarefas &gt; Tarefa (Tarefa)
    2. Contatos &gt; Contatos &gt; Pessoa Física (Usuário)
    3. Processos &gt; Pastas &gt; Processo/Recurso/Incidente (Pasta)
4. Depois clique em **Campos personalizados** e em **Adicionar**.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/akRimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/akRimage.png)

5. Preencher os campos e clicar em Salvar e Fechar:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/g5Gimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/g5Gimage.png)

#### **Campos**

##### **Tarefa**

<div align="left" dir="ltr" id="bkmrk-nome-do-campo-tipo-d"><table border="1" style="border-collapse: collapse; border-style: solid; width: 87.6543%; height: 426.293px;"><colgroup><col style="width: 16.5003%;" width="117"></col><col style="width: 15.6542%;" width="111"></col><col style="width: 31.3083%;" width="222"></col><col style="width: 16.6414%;" width="118"></col><col style="width: 19.885%;" width="141"></col></colgroup><tbody><tr style="height: 57.6989px;"><td style="height: 57.6989px;">**NOME DO CAMPO**

</td><td style="height: 57.6989px;">**TIPO DO CAMPO**

</td><td style="height: 57.6989px;">**DESCRIÇÃO**

</td><td style="height: 57.6989px;">**SISTEMAS**

</td><td style="height: 57.6989px;">**OBRIGATÓRIO**

</td></tr><tr style="height: 80.0994px;"><td style="height: 80.0994px;">**Número de Guia**

</td><td style="height: 80.0994px;">Campo Texto

</td><td style="height: 80.0994px;">Número da guia a ser vinculada

</td><td style="height: 80.0994px;">Esaj, Projudi PR, PJE RJ, TJ-RJ (Segweb)

</td><td style="height: 80.0994px;">Somente se uso

</td></tr><tr style="height: 57.6989px;"><td style="height: 57.6989px;">**Cumprir prazo**

</td><td style="height: 57.6989px;">Checkbox ou Lógica

</td><td style="height: 57.6989px;">Caso o robô tenha que cumprir algum prazo

</td><td style="height: 57.6989px;">Projudi PR, PJE e EPROC

</td><td style="height: 57.6989px;">Somente se uso

</td></tr><tr style="height: 57.6989px;"><td style="height: 57.6989px;">**Cumprir todos os prazos**

</td><td style="height: 57.6989px;">Checkbox ou Lógica

</td><td style="height: 57.6989px;">Caso o robô tenha que cumprir todos os prazos

</td><td style="height: 57.6989px;">Projudi PR, PJE e EPROC

</td><td style="height: 57.6989px;">Somente se uso

</td></tr><tr style="height: 57.6989px;"><td style="height: 57.6989px;">**Id do Prazo**

</td><td style="height: 57.6989px;">Campo Texto

</td><td style="height: 57.6989px;">Caso tenha mais de um prazo e o robô tenha que selecionar

</td><td style="height: 57.6989px;">Projudi PR, PJE e EPROC

</td><td style="height: 57.6989px;">Somente se uso

</td></tr><tr style="height: 80.0994px;"><td style="height: 80.0994px;">**Parte**

</td><td style="height: 80.0994px;">Campo Texto

</td><td style="height: 80.0994px;">Nome da parte que o robô deverá selecionar para protocolar

</td><td style="height: 80.0994px;">Esaj, PJE e EPROC

</td><td style="height: 80.0994px;">Não obrigatório, porém recomendado.

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">**Remover advogados habilitados**

</td><td style="height: 35.2983px;">Checkbox ou Lógica

</td><td style="height: 35.2983px;">Em habilitação e o robô precise remover os advogados já habilitados

</td><td style="height: 35.2983px;">PJE

</td><td style="height: 35.2983px;">Somente se uso

</td></tr><tr><td>**Categoria**

</td><td>Campo Texto

</td><td>Categoria do protocolo

</td><td>ESAJ

</td><td>Somente se uso do esaj e turma recursal

</td></tr><tr><td>****Grau****

</td><td>Select ou Lookup

</td><td>Grau do protocolo

</td><td>TODOS

</td><td>Obrigatório  
(primeiro-grau, segundo-grau, terceiro-grau, recursal)

</td></tr><tr><td>******Sistema******

</td><td>Select ou Lookup

</td><td>Sistema

</td><td></td><td>Obrigatório  
(pje, esaj, eproc, segweb, projudi, proprio)

</td></tr></tbody></table>

</div>##### **Usuário**

<div align="left" dir="ltr" id="bkmrk-nome-do-campo-tipo-d-1"><table border="1" style="border-collapse: collapse; border-style: solid;"><colgroup><col width="97"></col><col width="103"></col><col width="241"></col><col width="114"></col><col width="140"></col></colgroup><tbody><tr><td>**NOME DO CAMPO**

</td><td>**TIPO DO CAMPO**

</td><td>**DESCRIÇÃO**

</td><td>**SISTEMAS**

</td><td>**OBRIGATÓRIO**

</td></tr><tr><td>**CPF**

</td><td>Campo texto

</td><td>CPF do assinante, esse campo será utilizado para o robô identificar com qual credencial ele deverá protocolar

</td><td>  
TODOS

</td><td>  
Obrigatório

  
</td></tr></tbody></table>

</div>##### **Pasta**

<div align="left" dir="ltr" id="bkmrk-nome-do-campo-tipo-d-2"><table border="1" style="border-collapse: collapse; border-style: solid;"><colgroup><col width="96"></col><col width="85"></col><col width="207"></col><col width="126"></col><col width="182"></col></colgroup><tbody><tr><td>**NOME DO CAMPO**

</td><td>**TIPO DO CAMPO**

</td><td>**DESCRIÇÃO**

</td><td>**SISTEMAS**

</td><td>**OBRIGATÓRIO**

</td></tr><tr><td>**Parte**

</td><td>Campo Texto

</td><td>Nome da parte que o robô deverá selecionar para protocolar

</td><td>Esaj, PJE e EPROC

</td><td>Não obrigatório, porém recomendado.

</td></tr><tr><td>  
**Grau**

</td><td>Select ou Lookup

</td><td>  
Grau do protocolo

  
</td><td>  
TODOS

</td><td>Obrigatório

(primeiro-grau, segundo-grau, terceiro-grau, recursal)

</td></tr><tr><td>**Sistema**

</td><td>Select ou Lookup

</td><td>  
Sistema

</td><td>  
-

</td><td>Obrigatório

(pje, pje-habilitacao, esaj, eproc, segweb, projudi)

</td></tr></tbody></table>

</div>#### **Fluxo Do Robô**

<table border="1" id="bkmrk-pendente-%3E-iniciado-" style="border-collapse: collapse; width: 100%; height: 137.798px;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 35.2983px;"><td style="height: 35.2983px;">**PENDENTE &gt;**</td><td style="height: 35.2983px;">**INICIADO &gt;**

</td><td style="height: 35.2983px;">**CUMPRIDO/NÃO CUMPRIDO**</td></tr><tr style="height: 102.5px;"><td style="height: 102.5px;">Fase em que o robô entende que o protocolo ainda não foi feito e ele deve capturá-lo para protocolo.

</td><td style="height: 102.5px;">Fase em que o protocolo já está na oystr e o protocolo deverá ser feito.

</td><td style="height: 102.5px;">Fase que o robô já finalizou e devolve uma resposta e o campo observação da tarefa foi preenchido informado os dados do protocolo (se houver) ou erro.

</td></tr></tbody></table>

<p class="callout info">As fases que estão exibidas acima são personalizáveis. Caso o escritório tenha outro fluxo é necessário abrir uma task ao time de RPA para que o fluxo seja alterado. Nesse caso para que o ajuste seja mais preciso, deve-se apontar quais fases relacionam com as de cima.  
  
Por padrão as fases são escritas como: “Pendente”, “Iniciado”, “Não cumprido” e “Cumprido”</p>

Na última etapa (Cumprido e Não cumprido) o robô colocará uma observação detalhando o seu resultado:

- Se positivo, ele informará que o protocolo foi realizado.
- Se negativo, ele apontará que deu erro e o motivo do erro.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/5bAimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/5bAimage.png)


#### **Configuração Tarefa**

- A tarefa deve estar como pendente (ou fase correspondente).
- Precisa estar configurada para o dia em que o protocolo será feito.
- A tarefa deverá ter apenas um executante e esse deve ser o que está configurado no nosso painel (Passo 1).
- A opção cumprir prazos deverá estar marcada se e somente se houver a necessidade de que o robô cumpra o prazo.
- O documento que será anexo deve estar inserido dentro do GED da tarefa.
- Definir equivalências (Passo 5).
- O protocolo será iniciado 1h após o início definido na tarefa.
- Usamos esse tempo para caso o usuário tenha cadastrado algo errado ele consiga ajustar antes que o robô inicie o processo
- No exemplo a seguir, o robô irá iniciar o protocolo às 09h.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/EmJimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/EmJimage.png)

- O executante deverá ser o usuário cadastrado no cofre da Oystr.
    
    
    - No exemplo abaixo está marcado como Rob Oystr.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/CQGimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/CQGimage.png)

- Preencher os campos personalizados que são obrigatórios para o robô.
- Campos de Lógica (checkbox) deverão ser marcados se e somente se houver necessidade.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/x1Gimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/x1Gimage.png)

- O documento que será anexo deve estar inserido dentro do GED da tarefa.
- Após o protocolo ser realizado, será anexado o comprovante dentro do GED da tarefa.

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/LAximage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/LAximage.png)


#### **Equivalências**

Equivalência é como vamos definir o tipo do documento dentro do L1 com os tipos de protocolo que temos no tribunal.

São dois momentos que temos que configurar equivalências, 1ª inserção de documento no GED L1 e escolha do tipo.

1. No console selecione a opção equivalências:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/LxRimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/LxRimage.png)

2. Cadastrar

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/HBoimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/HBoimage.png)

3. Selecionar o bot que irá realizar o protocolo, digite o sistema e conseguirá procurar:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/Y7Timage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/Y7Timage.png)

4. Selecionado o bot, escolha o grau:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/nqeimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/nqeimage.png)

5. Serão abertos dois campos "tipo de protocolo" e "Tipo de arquivo":

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/VDKimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/VDKimage.png)

6. O "tipo de protocolo" é como consta na tarefa do L1 e qual tipo de protocolo deverá ser feito no tribunal:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/nkfimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/nkfimage.png)

7. O "tipo de arquivo" é o arquivo que subimos no GED da tarefa no L1:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/Rsmimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/Rsmimage.png)

#### **FAQ**

**É possível alterar a descrição das fases?**

Sim. Nesse caso, é necessário apontar ao time de RPA quais as fases o robô deverá olhar e o id da conta. Neste caso existem dois cenários:

1. Avisar o CS de Implantação no treinamento;
2. Abrir um chamado com o suporte solicitando alteração.

Em ambos os cenários informar quais são as descrições padrões e por quais substituir.

**O robô pode pegar o nome da parte pelos envolvidos da pasta?**

Sim. Isso é possível. O robô coleta as informações dos envolvidos que tenha uma descrição específica e nesse caso é personalizado para cada cliente.

**É possível diminuir ou aumentar o tempo de espera do início da tarefa?**

Sim. Porém isso ainda é realizado pelo time de desenvolvimento. Infra, Produto ou RPA. Neste caso existem dois cenários:

1. Avisar o CS de Implantação no treinamento;
2. Abrir um chamado com o suporte solicitando alteração.

**É possível reexecutar uma tarefa em caso de erro?**

Sim, porém não automaticamente. Nesse caso o usuário deverá ajustar os dados com erro (se houver) e mover novamente o status para pendente.

**Se não preencher o campo parte, de onde o robô coleta a informação?**

O robô pega a informação dentro da pasta através do campo Cliente principal.

**Pode enviar mais de uma parte no protocolo?**

Sim. O usuário deverá preencher o campo personalizado da tarefa e separar as partes por | (pipe).

#### **DÚVIDAS?**

Dúvidas, sugestões ou relatos de erros contidos neste documento, não deixe de informar nossas equipes de suporte:

**Andrews Angeli**

E-mail: <andrews.angeli@oystr.com.br>

**Caroline Mueller**

E-mail: [caroline.santos@oystr.com.b](mailto:caroline.santos@oystr.com.br)

# Orientações - API Ajuizamento

**ORIENTAÇÕES**

**INTEGRAÇÃO VIA API DE AJUIZAMENTO**

#### **DOCUMENTAÇÕES**

1. [API Ajuizamento](https://documenter.getpostman.com/view/7420272/UyxjHnDn#f18214c0-7069-48f9-b04e-c2d10741b56e)
2. [API Vault](https://api.oystr.com.br/vault/)
3. [API A2F](https://documenter.getpostman.com/view/7420272/UyxjHnDn#3f06a1bf-2638-4eaf-ae41-62c19ebe8009)
4. [Oráculo Robôs](http://dev.oystr.com.br/api/oracle/v1/bots/todos)
5. [Oráculo Tipos de Protocolos e Arquivos](https://dev.oystr.com.br/api/oracle/v1/cnj/50014622220208260046/protocolo)
6. [Limite de arquivo por tribunal](https://docs.google.com/spreadsheets/d/1Rxc5Wd8VNaVdOgMiLGCzVKtoOn5hsJdHmIkdBOca-Ek/edit?usp=sharing)
7. [Passo a passo de como cadastrar credenciais no painel](https://drive.google.com/file/d/1f3qkYrvsOTpFWaEf3DWtlt6KdBsqyJQ6/view?usp=sharing)
    
    
    - Caso você ou cliente tenha acesso
8. [Passo a passo de como cadastrar A2F no painel ](https://drive.google.com/file/d/1YEU3JBeqCruwBMB4AC860cpChKEgb73F/view?usp=sharing)
    
    
    - Caso você ou cliente tenha acesso
9. [Sistemas e formas de acesso](https://docs.google.com/spreadsheets/d/1Z3GQFWkUax5F1np-UfH3kGrk7MJFG2y00xlR5TBnlY4/edit?usp=sharing)

#### **ABRANGÊNCIA**

<div align="left" dir="ltr" id="bkmrk-sistema-tribunal-epr"><table border="1" style="border-collapse: collapse; border-style: solid; height: 269.489px; width: 100%;"><colgroup><col style="width: 36.4198%;" width="295"></col><col style="width: 36.5432%;" width="296"></col></colgroup><tbody><tr style="height: 35.2983px;"><td style="height: 35.2983px;">**SISTEMA**

</td><td style="height: 35.2983px;">**TRIBUNAL**

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">EPROC

</td><td style="height: 35.2983px;">RS, SC, TO, TRF2, JFES, JFRJ, TRF4, JFPR, JFRS e JFSC

</td></tr><tr style="height: 57.6989px;"><td style="height: 57.6989px;">PJE

</td><td style="height: 57.6989px;">RO, RN, PI, PB, PA, PE, MG, MT, MA, ES, DF, BA e CE. E tribunais TRF1 e TRF3

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">PROJUDI

</td><td style="height: 35.2983px;">PR e GO

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">ESAJ

</td><td style="height: 35.2983px;">AC, AL, AM, CE, MS, SC, SP

</td></tr></tbody></table>

</div>#### **FAQ**

##### <span style="text-decoration: underline;">****Ambiente de teste?****</span>

Para o nosso modelo de framework, por ora, não conseguimos ter um ambiente de teste. Sendo assim, existe a possibilidade de um ambiente controlado.

Neste teste "em produção", nós solicitamos um ou dois casos para testar o protocolo e com isso vamos crescendo gradualmente.

Devido ao cenário dos tribunais não conseguimos criar um ambiente de testes pois não é possível e nem temos como emular os cenários variados de respostas de erros (principalmente) que cada tribunal pode apresentar e isso é importante para configurar a API.

##### **Credenciais** 

O advogado pode acessar os sistemas por usuário/senha ou certificado A1.

##### **Cadastro no vault**

- Caso seja por usuário/senha, os acessos podem variar de tribunal para tribunal e, neste caso, o advogado deve cadastrar todas as credenciais no vault (passo a passo no tópico 7).
- Caso seja por certificado A1, o advogado deve cadastrar um certificado por sistema.
- Caso o escritório possua mais de um advogado, é necessário cadastrar o certificado de todos os advogados.


##### **Ajuizamento**

- Alguns sistemas não permitem realizar o login via certificado A1, mas é permitido assinar com ele. Neste campo enviar a senha do certificado. Usar nos tribunais, projudi PR, MT, AM, RR.
- Alguns sistemas não permitem realizar o login via certificado A1, mas é permitido assinar com ele. Neste campo enviar o base64 do certificado. Usar nos tribunais, projudi PR, MT, AM, RR.

##### **Configuração API**

- **X-Oystr-Auth** = Chave API gerada no painel da Oystr.
- **Hash credentials** = Hash da credencial salva no vault.
- Um cliente pode ter várias hash de credencial, porque para um estado ele pode usar o certificado do XXX em uma parte dos processos e do YYY para outra parte. Saber qual a credencial, vai fazer o robô protocolar o processo certo com a credencial correta.

- **Método** = **Assíncrono**. Ou seja, é realizada requisição e fica consultando de tempo em tempo para ver se ela terminou.

**ID’s Robôs**

```json
"bot": [
            "pje-tj-protocolo",
            "eproc-protocolo",
            "pje-trt-protocolo",
            "projudi-protocolo",
            "esaj-protocolo",
            "pje-tj-protocolo-habilitacao",
            "pje-trt-protocolo-habilitacao",
            "eproc-protocolo",
            "tj-rj-protocolo",
            "pje-tj-protocolo-v2",
            "tj-se-protocolo"
        ]

```

##### **Campos**

**Request**

- botId = Identificador oystr do bot
- integrationId = Identificador do cliente (Campo opcional)
- integracao = Número de integração com o ERP jurídico (Campo opcional; Exemplo: 20240130-02)
- idTramitacao = Número do protocolo no ERP jurídico. (Exemplo: 20240130-02-01)
- processo = Número do processo
- perfil = Perfil a realizar o protocolo (Exemplo: advogado, procurador, representante processual)
- oab = OAB do Advogado
- cumprirPrazo = Caso o cliente opte cumprir o prazo
- renunciarPrazo = Caso o cliente opte renunciar o prazo
- idsPrazoCumprir = ID da Intimação (Obrigatório somente nos casos em que o cliente opte por cumprir ou renunciar o prazo
- poloCliente = Polo da parte (Ativo ou Passivo - Obrigatoriedade vai depender do sistema do tribunal)
- tipoProtocolo = Tipo do protocolo (Exemplo: Solicitação de Habilitação)
- tipoProtocoloAuxiliar = Utilizado no TJRJ segweb em segunda instância onde o sistema solicita dois tipos de informação
- pedidoSustentacaoOral = Usado no TJRJ para informar se haverá pedido de sustentação oral.
- descricao = Descrição do protocolo (Text - Campo opcional; Exemplo: Solicitação de Habilitação)
- categoria = Categoria do protocolo (obrigatório somente no eSAJ)
- parteCliente = Nome da parte (Nome da parte, pode passar somente parte da informação.
- Se for mais de uma parte deverá enviar da seguinte forma: Parte1)
- sigilo = Caso o cliente opte pelo sigilo
- cumprirTodasIntimacoes = Caso o cliente opte cumprir todas as intimações ( No projudi-pr caso haja mais de uma intimação a ser cumprida e não enviar no atributo idsPrazoCumprir, o robô não fará o protocolo se não preencher esse parâmetro)
- grau = Grau a protocolar (Exemplo: primeiro-grau)
- assinarDocumento = Informar se o arquivo está assinado ou não
- textoPeca = Usado no PJe e deverá ser formatado em html. Texto
- tituloPeca = Título da peça do protocolo
- semHabilitar = Informar se o robô poderá protocolar caso o advogado não esteja habilitado.
- Somente para PJe e só funciona se o tribunal do estado permitir que seja feita o protocolo sem estar habilitado

- dividirArquivo = Nos portais há uma limitação de tamanho dos arquivos. Nos robôs do esaj e pje se marcado essa opção o robô ira dividir o arquivo caso haja a necessidade
- arquivos = Arquivos para realizar o protocolo
- tipoArquivo = Tipo documento (Exemplo: Petição)
- descricaoArquivo = Descrição do arquivo (Text - Campo opcional)
- sigilo = Sigilo do arquivo

- guias = Guias para vincular ao protocolo (Números - Campo opcional)
- justicaGratuita = Justiça Gratuita
- files = Arquivos
- name = Nome do arquivo (Usar o mesmo nome do objeto filho de "Arquivos")

- credentials = Hash da credencial cadastrada no vault (Exemplo: 0a2d0498-8711-4f36-bc66-90cd8598cf3a)
- status = Status do protocolo
- Create - Protocolo criado (Apenas cria o item e o deixa salvo no nosso servidor)
- Running - Protocolo em andamento
- Finished - Protocolo finalizado
- Pending - Protocolo pendente (Cria o item e após o envio dos arquivos coloca o item para ser executado)
- Error - Protocolo não realizado por algum erro
- Error Safe - Erro de instabilidade que pode ser retentado (O reenvio não é automático)
- Not Consistent - Caso tenha alguma configuração errada no envio do protocolo. Pode ser visto mais detalhes no campo "error"
- Send Files - Status de enviar arquivos está pendente


Para mais detalhes, acessar documentação no tópico “Data”:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/uIrimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/uIrimage.png)

##### **Response**

- Formato = Json
- status = retorno do protocolo
- Sucesso, Erro, Not found, OK

- itemId = ID do item
- archiveId = ID do arquivo
- batchId = Usado para buscar o protocolo no endpoint

# Orientações - API Protocolos

**ORIENTAÇÕES**

**INTEGRAÇÃO VIA API DE AJUIZAMENTO**

#### **DOCUMENTAÇÕES**

1. [API Ajuizamento](https://documenter.getpostman.com/view/7420272/UyxjHnDn#f18214c0-7069-48f9-b04e-c2d10741b56e)
2. [API Vault](https://api.oystr.com.br/vault/)
3. [API A2F](https://documenter.getpostman.com/view/7420272/UyxjHnDn#3f06a1bf-2638-4eaf-ae41-62c19ebe8009)
4. [Oráculo Robôs](http://dev.oystr.com.br/api/oracle/v1/bots/todos)
5. [Oráculo Tipos de Protocolos e Arquivos](https://dev.oystr.com.br/api/oracle/v1/cnj/50014622220208260046/protocolo)
6. [Limite de arquivo por tribunal](https://docs.google.com/spreadsheets/d/1Rxc5Wd8VNaVdOgMiLGCzVKtoOn5hsJdHmIkdBOca-Ek/edit?usp=sharing)
7. [Passo a passo de como cadastrar credenciais no painel](https://drive.google.com/file/d/1f3qkYrvsOTpFWaEf3DWtlt6KdBsqyJQ6/view?usp=sharing)
    
    
    - Caso você ou cliente tenha acesso
8. [Passo a passo de como cadastrar A2F no painel ](https://drive.google.com/file/d/1YEU3JBeqCruwBMB4AC860cpChKEgb73F/view?usp=sharing)
    
    
    - Caso você ou cliente tenha acesso
9. [Sistemas e formas de acesso](https://docs.google.com/spreadsheets/d/1Z3GQFWkUax5F1np-UfH3kGrk7MJFG2y00xlR5TBnlY4/edit?usp=sharing)

#### **ABRANGÊNCIA**

<div align="left" dir="ltr" id="bkmrk-sistema-tribunal-epr"><div align="left" dir="ltr"><table border="1" style="border-collapse: collapse; border-style: solid; height: 351px; width: 100%;"><colgroup><col style="width: 36.4198%;" width="295"></col><col style="width: 36.5432%;" width="296"></col></colgroup><tbody><tr><td>SISTEMA

</td><td>TRIBUNAL

</td></tr><tr><td>EPROC

</td><td>RS, SC, TO, TRF2, JFES, JFRJ, TRF4, JFPR, JFRS e JFSC

</td></tr><tr><td>PJE (válido para intermediário e habilitação)

</td><td>RO, RN, PI, PB, PA, PE, MG, MT, MA, ES, DF, BA e CE. E tribunais TRF1 e TRF3

</td></tr><tr><td>PROJUDI

</td><td>AM, BA, ES, GO, MT, PR e PI

</td></tr><tr><td>SEGWEB – SISTEMA PRÓPRIO

</td><td>RJ

</td></tr><tr><td>ESAJ

</td><td>Esaj - AC, AL, AM, CE, MS, SC, SP

</td></tr><tr><td>PJE TRT (válido para intermediário e habilitação)

</td><td>1 ao 24

</td></tr><tr><td>SISTEMA PRÓPRIO

</td><td>SE

</td></tr></tbody></table>

</div></div>#### **FAQ**

##### <span style="text-decoration: underline;">****Ambiente de teste?****</span>

Para o nosso modelo de framework, por ora, não conseguimos ter um ambiente de teste. Sendo assim, existe a possibilidade de um ambiente controlado.

Neste teste "em produção", nós solicitamos um ou dois casos para testar o protocolo e com isso vamos crescendo gradualmente.

Devido ao cenário dos tribunais não conseguimos criar um ambiente de testes pois não é possível e nem temos como emular os cenários variados de respostas de erros (principalmente) que cada tribunal pode apresentar e isso é importante para configurar a API.

##### **Credenciais** 

O advogado pode acessar os sistemas por usuário/senha ou certificado A1.

##### **Cadastro no vault**

- Caso seja por usuário/senha, os acessos podem variar de tribunal para tribunal e, neste caso, o advogado deve cadastrar todas as credenciais no vault (passo a passo no tópico 7).
- Caso seja por certificado A1, o advogado deve cadastrar um certificado por sistema.
- Caso o escritório possua mais de um advogado, é necessário cadastrar o certificado de todos os advogados.


##### **Ajuizamento**

- Alguns sistemas não permitem realizar o login via certificado A1, mas é permitido assinar com ele. Neste campo enviar a senha do certificado. Usar nos tribunais, projudi PR, MT, AM, RR.
- Alguns sistemas não permitem realizar o login via certificado A1, mas é permitido assinar com ele. Neste campo enviar o base64 do certificado. Usar nos tribunais, projudi PR, MT, AM, RR.

##### **Configuração API**

- **X-Oystr-Auth** = Chave API gerada no painel da Oystr.
- **Hash credentials** = Hash da credencial salva no vault.
- Um cliente pode ter várias hash de credencial, porque para um estado ele pode usar o certificado do XXX em uma parte dos processos e do YYY para outra parte. Saber qual a credencial, vai fazer o robô protocolar o processo certo com a credencial correta.

- **Método** = **Assíncrono**. Ou seja, é realizada requisição e fica consultando de tempo em tempo para ver se ela terminou.

**ID’s Robôs**

```json
"bot": [
            "pje-tj-protocolo",
            "eproc-protocolo",
            "pje-trt-protocolo",
            "projudi-protocolo",
            "esaj-protocolo",
            "pje-tj-protocolo-habilitacao",
            "pje-trt-protocolo-habilitacao",
            "eproc-protocolo",
            "tj-rj-protocolo",
            "pje-tj-protocolo-v2",
            "tj-se-protocolo"
        ]
```

##### **Campos**

**Request**

- botId = Identificador oystr do bot
- integrationId = Identificador do cliente (Campo opcional)
- integracao = Número de integração com o ERP jurídico (Campo opcional; Exemplo: 20240130-02)
- idTramitacao = Número do protocolo no ERP jurídico. (Exemplo: 20240130-02-01)
- processo = Número do processo
- perfil = Perfil a realizar o protocolo (Exemplo: advogado, procurador, representante processual)
- oab = OAB do Advogado
- cumprirPrazo = Caso o cliente opte cumprir o prazo
- renunciarPrazo = Caso o cliente opte renunciar o prazo
- idsPrazoCumprir = ID da Intimação (Obrigatório somente nos casos em que o cliente opte por cumprir ou renunciar o prazo
- poloCliente = Polo da parte (Ativo ou Passivo - Obrigatoriedade vai depender do sistema do tribunal)
- tipoProtocolo = Tipo do protocolo (Exemplo: Solicitação de Habilitação)
- tipoProtocoloAuxiliar = Utilizado no TJRJ segweb em segunda instância onde o sistema solicita dois tipos de informação
- pedidoSustentacaoOral = Usado no TJRJ para informar se haverá pedido de sustentação oral.
- descricao = Descrição do protocolo (Text - Campo opcional; Exemplo: Solicitação de Habilitação)
- categoria = Categoria do protocolo (obrigatório somente no eSAJ)
- parteCliente = Nome da parte (Nome da parte, pode passar somente parte da informação.
- Se for mais de uma parte deverá enviar da seguinte forma: Parte1)
- sigilo = Caso o cliente opte pelo sigilo
- cumprirTodasIntimacoes = Caso o cliente opte cumprir todas as intimações ( No projudi-pr caso haja mais de uma intimação a ser cumprida e não enviar no atributo idsPrazoCumprir, o robô não fará o protocolo se não preencher esse parâmetro)
- grau = Grau a protocolar (Exemplo: primeiro-grau)
- assinarDocumento = Informar se o arquivo está assinado ou não
- textoPeca = Usado no PJe e deverá ser formatado em html. Texto
- tituloPeca = Título da peça do protocolo
- semHabilitar = Informar se o robô poderá protocolar caso o advogado não esteja habilitado.
- Somente para PJe e só funciona se o tribunal do estado permitir que seja feita o protocolo sem estar habilitado

- dividirArquivo = Nos portais há uma limitação de tamanho dos arquivos. Nos robôs do esaj e pje se marcado essa opção o robô ira dividir o arquivo caso haja a necessidade
- arquivos = Arquivos para realizar o protocolo
- tipoArquivo = Tipo documento (Exemplo: Petição)
- descricaoArquivo = Descrição do arquivo (Text - Campo opcional)
- sigilo = Sigilo do arquivo

- guias = Guias para vincular ao protocolo (Números - Campo opcional)
- justicaGratuita = Justiça Gratuita
- files = Arquivos
- name = Nome do arquivo (Usar o mesmo nome do objeto filho de "Arquivos")

- credentials = Hash da credencial cadastrada no vault (Exemplo: 0a2d0498-8711-4f36-bc66-90cd8598cf3a)
- status = Status do protocolo
- Create - Protocolo criado (Apenas cria o item e o deixa salvo no nosso servidor)
- Running - Protocolo em andamento
- Finished - Protocolo finalizado
- Pending - Protocolo pendente (Cria o item e após o envio dos arquivos coloca o item para ser executado)
- Error - Protocolo não realizado por algum erro
- Error Safe - Erro de instabilidade que pode ser retentado (O reenvio não é automático)
- Not Consistent - Caso tenha alguma configuração errada no envio do protocolo. Pode ser visto mais detalhes no campo "error"
- Send Files - Status de enviar arquivos está pendente


Para mais detalhes, acessar documentação no tópico “Data”:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/uIrimage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/uIrimage.png)

##### **Response**

- Formato = Json
- status = retorno do protocolo
- Sucesso, Erro, Not found, OK

- itemId = ID do item
- archiveId = ID do arquivo
- batchId = Usado para buscar o protocolo no endpoint

# Orientações  - API Capa

**ORIENTAÇÕES**

**INTEGRAÇÃO VIA API DE CAPA (INFORMAÇÕES)**

#### **DOCUMENTAÇÕES**

1. [API Capa (Informações)](https://documenter.getpostman.com/view/7420272/UyxjHnDn#b16fbfef-57b3-4d0e-a980-131f6ca1b35e)
2. [API Vault](https://api.oystr.com.br/vault/)
3. [API A2F](https://documenter.getpostman.com/view/7420272/UyxjHnDn#3f06a1bf-2638-4eaf-ae41-62c19ebe8009)
4. [Passo a passo de como cadastrar credenciais no painel](https://drive.google.com/file/d/1f3qkYrvsOTpFWaEf3DWtlt6KdBsqyJQ6/view?usp=sharing)
    
    
    - Caso você ou cliente tenha acesso
5. [Passo a passo de como cadastrar A2F no painel ](https://drive.google.com/file/d/1YEU3JBeqCruwBMB4AC860cpChKEgb73F/view?usp=sharing)
    
    
    - Caso você ou cliente tenha acesso
6. [Sistemas e formas de acesso](https://docs.google.com/spreadsheets/d/1Z3GQFWkUax5F1np-UfH3kGrk7MJFG2y00xlR5TBnlY4/edit?usp=sharing)

#### **ABRANGÊNCIA**

<div align="left" dir="ltr" id="bkmrk-sistema-tribunal-epr"><table border="1" style="border-collapse: collapse; border-style: solid; height: 264px; width: 100%;"><colgroup><col style="width: 36.4198%;" width="295"></col><col style="width: 36.5432%;" width="296"></col></colgroup><tbody><tr><td>SISTEMA

</td><td>TRIBUNAL

</td></tr><tr><td>EPROC

</td><td>RS, SC, TO, TRF2, JFES, JFRJ, TRF4, JFPR, JFRS e JFSC

</td></tr><tr><td>PJE

</td><td>RO, RN, PI, PB, PA, PE, MG, MT, MA, ES, DF, BA e CE. E tribunais TRF1 e TRF3

</td></tr><tr><td>PROJUDI

</td><td>AM, BA, ES, GO, MT, PR e PI

</td></tr><tr><td>ESAJ

</td><td>AC, AL, AM, CE, MS, SC, SP

</td></tr><tr><td>PJE TRT

</td><td>1 ao 24

</td></tr></tbody></table>

</div>#### **FAQ**

**Ambiente de teste?**

Para o nosso modelo de framework, por ora, não conseguimos ter um ambiente de teste. Sendo assim, existe a possibilidade de um ambiente controlado.

Neste teste "em produção", nós solicitamos XXXXX.

Devido ao cenário dos tribunais não conseguimos criar um ambiente de testes pois não é possível e nem temos como emular os cenários variados de respostas de erros (principalmente) que cada tribunal pode apresentar e isso é importante para configurar a API.

**Credenciais**

O advogado pode acessar os sistemas por usuário/senha ou certificado A1.

**Cadastro no vault**

- Caso seja por usuário/senha, os acessos podem variar de tribunal para tribunal e, neste caso, o advogado deve cadastrar todas as credenciais no vault.
    
    
    - Caso o escritório possua mais de um advogado, é necessário cadastrar o certificado de todos os advogados.
- Caso seja por certificado A1, o advogado deve cadastrar um certificado por sistema.
- Caso seja usuário/senha, o advogado deve cadastrar por sistema ou estado.

- No Projudi BA e PR o acesso é somente com usuário/senha;

**Configuração API**

- **Formato da Requisição do robô**: via HTTP
- **X-Oystr-Auth** = Chave API gerada no painel da Oystr.
- **Hash credentials** = Hash da credencial salva no vault.
- Um cliente pode ter várias hash de credencial, porque para um estado ele pode usar o certificado do XXX em uma parte dos processos e do YYY para outra parte.


**ID’s Robôs**

```json
"bot": [
            "esaj-info",
            "eproc-info",
            "projudi-go-info",
            "projudi-ba-info",
            "projudi-mt-info",
            "projudi-pr-info",
            "pje-info",
            "pje-tj-rj-publico-informacoes",
        ]

```

**Campos**

```json
{
    "dry": false,
    "bot": "esaj-info",
    "version": "v3.0.0-dev",
    "cid": "",
    "timeout": "",
    "deadline": "",
    "data": {
        "processo": "",
        "degree": "",
        "inicial": "",
    },
    "credentials": {
        "username": "user",
        "pin": "senha",
        "base64Cert": "[base64]",
        "credentialsOption": "RJ"
    }
}

```

**Request**

- bot = Identificador oystr do bot
- credentials = Credencial de acesso ao tribunal. Pode ser usuário/senha ou certificado A1.
    
    
    - “username” = Usuário (varia entre OAB, CPF, entre outros)
    - “password” = Senha
    
    
    - “username” = CPF
    - “pin” = Senha do certificado
    - “base64Cert” = Base64 do certificado
    - “hash” = Hash gerado pelo cofre (se a credencial estiver salva no nosso cofre)
    - "credentialsOption" = UF do tribunal
- Se for usuário/senha enviar:
- Se for certificado A1 enviar:

- “process” = Número do processo
- “degree” = Grau em que o robô deverá fazer o protocolo. Ex: primeiro-grau ou segundo-grau
- “inicial” = Trazer petição inicial no resultado (True ou False)
- Para mais detalhes, acessar documentação no tópico “DATA”:

[![image.png](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/scaled-1680-/Y0Simage.png)](https://wiki.oystr.com.br/uploads/images/gallery/2024-03/Y0Simage.png)

**Response**

- Formato = Json
    
    
    - Sucesso, Erro, Not found, OK
- status = retorno do protocolo

# Orientações - API Distribuição

**ORIENTAÇÕES**

**INTEGRAÇÃO VIA API DE DISTRIBUIÇÃO**

#### **DOCUMENTAÇÕES**

1. [API Distribuição](https://documenter.getpostman.com/view/7420272/UyxjHnDn#45ce3ea3-4071-4cd4-aa91-5934304f80ca)

#### **ABRANGÊNCIA**

<table border="1" id="bkmrk-jf-ac-tj-mg-tre-rn-j" style="border-collapse: collapse; width: 100%; height: 297.017px;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-AC</td><td style="height: 29.7017px;">TJ-MG</td><td style="height: 29.7017px;">TRE-RN</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-AL</td><td style="height: 29.7017px;">TJ-MS</td><td style="height: 29.7017px;">TRE-RO</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-AM</td><td style="height: 29.7017px;">TJ-MT</td><td style="height: 29.7017px;">TRE-RR</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-AP</td><td style="height: 29.7017px;">TJ-PA</td><td style="height: 29.7017px;">TRE-RS</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-BA</td><td style="height: 29.7017px;">TJ-PB</td><td style="height: 29.7017px;">TRE-SC</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-CE</td><td style="height: 29.7017px;">TJ-PE</td><td style="height: 29.7017px;">TRE-SE</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-DF</td><td style="height: 29.7017px;">TJ-PI</td><td style="height: 29.7017px;">TRE-SP</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-ES</td><td style="height: 29.7017px;">TJ-PR</td><td style="height: 29.7017px;">TRE-TO</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-GO</td><td style="height: 29.7017px;">TJ-RJ</td><td style="height: 29.7017px;">TRF-1</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-MA</td><td style="height: 29.7017px;">TJ-RN</td><td style="height: 29.7017px;">TRF-2</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-MG</td><td style="height: 29.7017px;">TJ-RO</td><td style="height: 29.7017px;">TRF-3</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-MS</td><td style="height: 29.7017px;">TJ-RR</td><td style="height: 29.7017px;">TRF-4</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-MT</td><td style="height: 29.7017px;">TJ-RS</td><td style="height: 29.7017px;">TRF-5</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-PA</td><td style="height: 29.7017px;">TJ-SC</td><td style="height: 29.7017px;">TRT-1</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-PB</td><td style="height: 29.7017px;">TJ-SE</td><td style="height: 29.7017px;">TRT-10</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-PE</td><td style="height: 29.7017px;">TJ-SP</td><td style="height: 29.7017px;">TRT-11</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-PI</td><td style="height: 29.7017px;">TJ-TO</td><td style="height: 29.7017px;">TRT-12</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-PR</td><td style="height: 29.7017px;">TJM-MG</td><td style="height: 29.7017px;">TRT-13</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-RJ</td><td style="height: 29.7017px;">TJM-RS</td><td style="height: 29.7017px;">TRT-14</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-RN</td><td style="height: 29.7017px;">TJM-SP</td><td style="height: 29.7017px;">TRT-15</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-RO</td><td style="height: 29.7017px;">TRE-AC</td><td style="height: 29.7017px;">TRT-16</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-RR</td><td style="height: 29.7017px;">TRE-AL</td><td style="height: 29.7017px;">TRT-17</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-RS</td><td style="height: 29.7017px;">TRE-AM</td><td style="height: 29.7017px;">TRT-18</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-SC</td><td style="height: 29.7017px;">TRE-AP</td><td style="height: 29.7017px;">TRT-19</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-SE</td><td style="height: 29.7017px;">TRE-BA</td><td style="height: 29.7017px;">TRT-2</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-SP</td><td style="height: 29.7017px;">TRE-CE</td><td style="height: 29.7017px;">TRT-20</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">JF-TO</td><td style="height: 29.7017px;">TRE-DF</td><td style="height: 29.7017px;">TRT-21</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">STF</td><td style="height: 29.7017px;">TRE-DFT</td><td style="height: 29.7017px;">TRT-22</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">STJ</td><td style="height: 29.7017px;">TRE-ES</td><td style="height: 29.7017px;">TRT-23</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-AC</td><td style="height: 29.7017px;">TRE-GO</td><td style="height: 29.7017px;">TRT-24</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-AL</td><td style="height: 29.7017px;">TRE-MA</td><td style="height: 29.7017px;">TRT-3</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-AM</td><td style="height: 29.7017px;">TRE-MG</td><td style="height: 29.7017px;">TRT-4</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-AP</td><td style="height: 29.7017px;">TRE-MS</td><td style="height: 29.7017px;">TRT-5</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-BA</td><td style="height: 29.7017px;">TRE-MT</td><td style="height: 29.7017px;">TRT-6</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-CE</td><td style="height: 29.7017px;">TRE-PA</td><td style="height: 29.7017px;">TRT-7</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-DF</td><td style="height: 29.7017px;">TRE-PB</td><td style="height: 29.7017px;">TRT-8</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-DFT</td><td style="height: 29.7017px;">TRE-PE</td><td style="height: 29.7017px;">TRT-9</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-ES</td><td style="height: 29.7017px;">TRE-PI</td><td style="height: 29.7017px;">TSE</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-GO</td><td style="height: 29.7017px;">TRE-PR</td><td style="height: 29.7017px;">TST</td></tr><tr style="height: 29.7017px;"><td style="height: 29.7017px;">TJ-MA</td><td style="height: 29.7017px;">TRE-RJ</td><td style="height: 29.7017px;">  
</td></tr></tbody></table>

#### **FAQ**

<span style="text-decoration: underline;">**Ambiente de teste?**</span>

Para o nosso modelo de framework, por ora, não conseguimos ter um ambiente de teste. Sendo assim, existe a possibilidade de um ambiente controlado.

Neste teste "em produção" é necessário configurar no App de Distribuição um termo de pesquisa, bem como a abrangência, grau, etc, e, assim, crescer gradualmente.

Devido ao cenário dos tribunais não conseguimos criar um ambiente de testes pois não é possível e nem temos como emular os cenários variados de respostas de erros (principalmente) que cada tribunal pode apresentar e isso é importante para configurar a API.

<span style="text-decoration: underline;">**Configuração Webhooks**</span>

- Webhooks são usados para notificar o cliente quando os mesmos recebem novas distribuições. Para receber webhooks do App de Distribuições é necessário disponibilizar um endpoint para receber os disparos, que são requisições POST.
- X-Oystr-Auth = Chave API gerada no painel da Oystr.
- Ao receber novas distribuições, os webhooks irão notificar a url cadastrada com o seguinte corpo:

```json
{
  "webhookId": "id",
  "entity": {
    "type": "user",
    "id": "id",
    "username": "username"
  },
  "lastUpdateAt": null,
  "lastViewedAt": null,
  "endpoints": {
    "result": "/webhook/:id/results",
    "callback": "/webhook/:id/callback"
  }
}

```

- webhookId = ID do webhook
- entity = Dados internos
- lastUpdateAt = Última notificação realizada
- lastViewedAt = Última visualização de novas distribuições
- endpoints = Endpoints de auxílio para visualização dos resultados

- Você receberá um ID para consultar o resultado da chamada posteriormente.
- O design da API leva em consideração o tempo que os robôs demoram para executar uma determinada tarefa.

- O disparo de webhooks exige um endpoint público para receber os disparos. Assim que configurado, enviar para Oystr realizar a configuração interna.
- A configuração do endereço é aplicada apenas a novas operações, então as que já ocorreram não serão disparadas automaticamente.
- Tipo requisição: GET;
- ID = ID (identificador único) da execução criada.

<span style="text-decoration: underline;">**Campos**</span>

**Cadastro de dados**

- <span style="text-decoration: underline;">Tipo de consulta:</span>
- Pessoa Física;
- Pessoa Jurídica;
- Advogado;
- Assunto;
- Classe.

- <span style="text-decoration: underline;">Instância</span>:
- Primeira instância;
- Segunda instância;
- Terceira instância.

- <span style="text-decoration: underline;">Busca retroativa (dias):</span>
- Exemplo: 120 dias;
- A partir de 2015/2016.

- <span style="text-decoration: underline;">Abrangência</span>
- Nacional;
- Tribunais disponibilizados na tabela.

- <span style="text-decoration: underline;">Termo</span>:
- É possível buscar por: CNPJ, CPF, OAB, Nome ou termo (caracter, palavra, frase)
- Exemplo: 90.400.888/0001-42; Banco Santander.
- Cada termo inserido é buscado de **modo individual**, eles não são somados. Ex: adicionamos um termo "111.111.111-11 (CNPJ)" e outro termo "Dr. Teste", **ESSES TERMOS NÃO SÃO BUSCADOS DE MODO CONJUNTO, E SIM SEPARADO**. Portanto, "Dr. Teste" é uma busca e "111.111.111-11 (CNPJ)" é outra busca separada. Nesse momento ainda não conseguimos correlacionar os termos.
- O termo tem que ser exatamente como consta no tribunal.
- IMPORTANTE: Existem sistemas que não disponibilizam o CNPJ na capa do processo. Sendo assim, é necessário cadastrar tanto o CNPJ quanto o nome da parte.

- <span style="text-decoration: underline;">E-mail:</span>
- Cadastro de e-mail para recebimento de notificações de novos processos.
- Ainda em produção.

- <span style="text-decoration: underline;">Rotina personalizada: </span>
- Exemplo: OAB + CNPJ &gt;&gt; Só dá aplicar pelo backend;
- Solicitar para Caroline.


**Response**

Na **primeira entrega**, o robô deve demorar de 5 a 7 dias para os processos já disponibilizados.

Após isto, o robô terá resultados diários ou de acordo com a realidade, mas com até 5 dias de atraso, pois dependemos da postagem da inicial, além do processo, para garantir a captura.

**Exemplos de campos**:

<p class="callout info">Nem todos os sistemas fornecem os dados. Nos casos em que não tiver a informação, o campo virá nulo (null).   
</p>

- id = ID
- dataDistribuicao = Data da distribuição (Exemplo: 2024-01-10T11:23:24-03:00)
- termo = Termo cadastrado (Exemplo: Banco Santander)
- tribunal = Tribunal (Exemplo: TJ-PR)
- numeroProcesso = Número do processo (Formato CNJ; Exemplo: 0000000-00.0000.0.00.0000)
- tipoOcorrencia = Tipo de ocorrência (Exemplo: Ação Trabalhista)
- reu = Nome do réu
- autor = Nome do autor
- forum = Fórum (Exemplo: TJ-PR)
- vara = Nome da Vara (Exemplo: 7ª Vara Cível de Curitiba)
- cidade = Nome da Cidade (Exemplo: Curitiba)
- uf = UF do tribunal (Exemplo: PR)
- valorOcorrencia = Valor da causa (Exemplo: 100.000)
- advogadoautor = Nome advogado do autor
- publicacao = null
- linkDocumentosIniciais = Link da inicial (Exemplo: [https://loremipsum.com.br/lorem.pdf](https://loremipsum.com.br/lorem.pdf))
- processoEletronico = Número do processo (Formato CNJ; Exemplo: 0000000-00.0000.0.00.0000)
- tipoProcesso = Tipo de processo (Exemplo: Ação Trabalhista)
- instancia = Instância cadastrada (1, 2 ou 3)
- assunto = Assunto do processo (Exemplo: Horas Extras)
- juiz = Nome do juiz da causa
- createdAt = Data da criação da requisição/Data do cadastro (Exemplo: 2024-01-11T13:35:21.420Z)

<p class="callout info">Em caso de dúvidas, acionar Caroline, Matheus ou Andrews.</p>

# Orientações - API Intimações

**ORIENTAÇÕES**

**INTEGRAÇÃO VIA API DE INTIMAÇÕES**

#### **DOCUMENTAÇÕES**

1. [API Intimações](https://documenter.getpostman.com/view/7420272/UyxjHnDn#f1d1df51-8dab-494b-a8f8-93a1d7fbb391)
2. [API Vault](https://api.oystr.com.br/vault/)
3. [API A2F](https://documenter.getpostman.com/view/7420272/UyxjHnDn#3f06a1bf-2638-4eaf-ae41-62c19ebe8009) (Validar tribunais no documento “Sistemas e formas de acesso”)
4. [Passo a passo de como cadastrar credenciais no painel](https://drive.google.com/file/d/1f3qkYrvsOTpFWaEf3DWtlt6KdBsqyJQ6/view?usp=sharing)
    
    
    - Caso você ou cliente tenha acesso
5. [Passo a passo de como cadastrar A2F no painel ](https://drive.google.com/file/d/1YEU3JBeqCruwBMB4AC860cpChKEgb73F/view?usp=sharing)
    
    
    - Caso você ou cliente tenha acesso
6. [Sistemas e formas de acesso](https://docs.google.com/spreadsheets/d/1Z3GQFWkUax5F1np-UfH3kGrk7MJFG2y00xlR5TBnlY4/edit?usp=sharing):

#### **ABRANGÊNCIA**

<div align="left" dir="ltr" id="bkmrk-sistema-tribunal-epr"><table border="1" style="width: 105.556%; height: 637px; border-collapse: collapse; border-style: solid;"><colgroup><col style="width: 49.9087%;" width="295"></col><col style="width: 50.0779%;" width="296"></col></colgroup><tbody><tr style="height: 35.2983px;"><td style="height: 35.2983px;">SISTEMA

</td><td style="height: 35.2983px;">TRIBUNAL

</td></tr><tr style="height: 57.6989px;"><td style="height: 57.6989px;">EPROC - 1º e 2º grau

</td><td style="height: 57.6989px;">RS, SC, TO, TRF2, JFES, JFRJ, TRF4, JFPR, JFRS e JFSC

</td></tr><tr style="height: 169.702px;"><td style="height: 169.702px;">PJE - 1º e 2º grau

</td><td style="height: 169.702px;">AP, RO, RN, PI, PB, PA, PE, MG (1º grau e Recursal), MG (JPe - 2º Grau), MT, MA, ES (1º grau e Recursal), DF, BA, CE, RJ (1º grau), TRF1, TRF3 TRF5 (antigo e novo), TRF6, JFAL, JFCE, JFPB, JFPE, JFRN, JFSE, TSE, TRE'S CNJ, Corregedoria Nacional e Corregedoria Geral PB.

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">PJE - Pautas

</td><td style="height: 35.2983px;">TRF5, JFAL, JFCE, JFPB, JFPE, JFRN, JFSE

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">PJE - RPV

</td><td style="height: 35.2983px;">TRF5, JFAL, JFCE, JFPB, JFPE, JFRN, JFSE

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">PROJUDI - 1º e 2º grau

</td><td style="height: 35.2983px;">AM, BA, ES, GO, MT, PR e PI

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">SEGWEB – SISTEMA PRÓPRIO - 1º e 2º grau

</td><td style="height: 35.2983px;">RJ

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">PJE TRT

</td><td style="height: 35.2983px;">1 ao 24

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">CRETA

</td><td style="height: 35.2983px;">JFAL, JFCE, JFPB, JFPE, JFRN, JFSE

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">TUCUJURIS

</td><td style="height: 35.2983px;">AP

</td></tr><tr style="height: 80.0994px;"><td style="height: 80.0994px;">E-CINT

</td><td style="height: 80.0994px;">TRF1, JFAC, JFAM, JFAP, JFBA, JFDF, JFGO, JFMA, JFMG, JFMT, JFPA, JFPI, JFRO, JFRR, JFTO

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">STJ

</td><td style="height: 35.2983px;">STJ

</td></tr><tr style="height: 35.2983px;"><td style="height: 35.2983px;">PDPJ

</td><td style="height: 35.2983px;">Domicílio Judicial

</td></tr></tbody></table>

</div>#### **FAQ**

<span style="text-decoration: underline;">**Ambiente de teste?**</span>

Para o nosso modelo de framework, por ora, não conseguimos ter um ambiente de teste. Sendo assim, existe a possibilidade de um ambiente controlado.

Neste teste "em produção" é necessário configurar no App de Intimações um perfil de tribunal para não dar leitura na intimação e, assim, crescer gradualmente.

Devido ao cenário dos tribunais não conseguimos criar um ambiente de testes pois não é possível e nem temos como emular os cenários variados de respostas de erros (principalmente) que cada tribunal pode apresentar e isso é importante para configurar a API.

IMPORTANTE: Existem sistemas que não disponibilizam o documento (anexo) caso não haja leitura da intimação (exemplo: PJe). Caso o documento seja imprescindível para a configuração da integração, indicamos o cadastro de um perfil dos sistemas Eproc ou Projudi (exceto BA).

<span style="text-decoration: underline;">**Credenciais**</span>

- O advogado pode acessar os tribunais por usuário/senha ou certificado A1.
- Caso seja por usuário/senha, os acessos podem variar de tribunal para tribunal e, neste caso, o advogado deve cadastrar todas as credenciais no vault (passo a passo no tópico 4).
- Caso seja por certificado A1, o advogado deve cadastrar um certificado por sistema.
- Caso o escritório possua mais de um advogado, é necessário cadastrar o certificado de todos os advogados.



<span style="text-decoration: underline;">**Tribunais que não permitem baixar dados sem dar ciência (obrigatório dar leitura na intimação):**</span>

- Projudi BA;
- JPe - MG 2º grau;
- Creta;
- Tucujuris;
- E-cint.

**Configuração Webhooks**

- Para receber webhooks do App de intimações é necessário disponibilizar um endpoint para receber os disparos, que são requisições POST.
- **X-Oystr-Auth** = Chave API gerada no painel da Oystr.
- **Método = Assíncrono**. Ou seja, quando o webhook for disparado, o resultado já estará pronto.
- Formato body (na parte Conteúdo Webhook Principal):
- Usuário e senha:


```json
{
    "configName": "nome-perfil",
    "executionId": "id-execucao",
    "bot": "pje-tj-intimation",
    "credentials": {
        "username": "username",
        "credentialType": "password"
    },
    "resultEndpoint": "/results/id-execucao"
}

```

- - Certificado A1:

```json
{
   "username": "...",
   "base64Cert": "...",
   "pin": "...",
   "credentialsOption": "..."
}

```

- - - configName = Nome da configuração.
        - executionId = ID da execução.
        - bot = ID do robô para conferência no painel da Oystr.
        - credentials = Resumo das credenciais utilizadas.
        - resultEndpoint = Endpoint para consulta dos resultados.

- Você receberá um ID para consultar o resultado da chamada posteriormente.
    
    
    - O design da API leva em consideração o tempo que os robôs demoram para executar uma determinada tarefa.
- O disparo de webhooks exige um endpoint público para receber os disparos. Assim que configurado, enviar para Oystr realizar a configuração interna.
- O disparo dos webhooks não está diretamente ligado aos horários de agendamento. Eles dependem de quanto tempo será necessário para listar, selecionar, capturar e processar os resultados, portanto é um agendamento pro começo da atividade, porém, o disparo em si será feito ao fim, e esse tempo varia.
- A configuração do endereço é aplicada apenas a novas operações, então as que já ocorreram não serão disparadas automaticamente.
- Para autenticação podemos especificar headers a serem utilizados nos disparos, e também podemos informar a vocês de antemão o IP do servidor que fará a requisição, caso queiram restringir no firewall.
- Retorno - No caso de sucesso da execução deste método, a API retornará um ID, que poderá ser utilizado em futuras consultas, para obter o retorno da protofila (lembrando: dados que servirão de subsídio para a execução final).
    
    
    - Tipo requisição: GET;
    - Tipo resposta: SÍNCRONA
- ID = ID (identificador único) da execução criada.

**Campos**

A padronização dos campos funciona diferente no request e no response.

O request é a listagem da intimação, esse varia radicalmente os nomes dos campos (e quais existem) e também na informação de cada campo.

Já o response é o conteúdo em si. Este possui os campos padronizados, mas o preenchimento dependerá do portal do tribunal, ou seja, campos null em um podem estar preenchidos em outro.

O app de intimações também aplica uma etapa de pós-processamento antes da disponibilização para padronizar alguns campos de data tanto do request quanto do response e é aplicado por padrão no formato DD/MM/YYYY.

**Response**

- Notices - Existem sistemas que disponibilizam mais de uma intimação do mesmo processo e, nestes casos, é possível que o campo traga mais de 1 item (exemplo: eproc).
- Link do documento - O link do documento não é enviado pela API, ele vai embutido em base64.
- O anexo possui o texto extraído, nome de arquivo e a sequência de bytes (data).
- Onde encontrar? No campo data nos itens do attachments.


```json
 "attachments": [
                  {
                    "type": "raw",
                    "error": false,
                    "name": "intimacao-0000000020228200000-1qKMnV.pdf",
                    "text": "27/02/2024\nNúmero: 0000000-00.2022.8.20.0000 \n \nClasse: CUMPRIMENTO DE SENTENÇA \n Órgão julgador: 5º Juizado Especial Cível e ...",
                    "description": null,
                    "data": "JVBERi0xLjQKJeLjz9MK...",
                    "link": null
                  }
                ],

```

**Exemplos de campos:**

<p class="callout warning">Nem todos os sistemas fornecem os dados. Nos casos em que não tiver a informação, o campo virá nulo (null).</p>

- id = ID
- idOystr = ID Oystr
- ProcessNumber - Número do Processo
- origin = Diário
- author = Autor
- defendant = Réu
- other = Outras partes
- postDate = Data da postagem
- automatic = Caso a intimação tenha sido automática
- date = Data da intimação
- dateHour = Horário da intimação
- period = Período para cumprimento da intimação (5, 10, 15 dias ou sem prazo)
- processType = Classe processual
- periodStart = Primeiro dia do prazo
- periodEnd = Último dia prazo
- type = Tipo
- meioComunicacao = Meio de comunicação
- assignment = Data distribuição do processo
- personal = Pessoal
- juizo = Juízo
- fulfillmentDate = Data de cumprimento
- reader = Leitor
- update = Movimentação
- event = Evento
- text = Texto da intimação (caso haja leitura na intimação a depender do tribunal)
- status = Status
- lawyer = Nome Advogado
- data = Dados
- attachments = Documentos

#### **Erros**

- INVALID = Inválido
- QUEUED = Não enviado
- REQ = Perdido
- RES = Ok
- ERR = Erro
- PARTIAL\_RESPONSE = Parcial
- TIMEOUT = Tempo esgotado
- NOT\_FOUND = Não encontrado
- NOT\_ALLOWED = Acesso negado
- NOT\_CONSISTENT = Dados inconsistentes
- OTHER = Outros
- NOT\_AVAILABLE = Indisponível
- FORBIDDEN = Proibido
- CAPTCHA\_ERROR = Erro de captcha
- PROXY\_ERROR = Erro de proxy

<p class="callout info">Em caso de dúvidas, acionar Caroline, Matheus ou Lucas.</p>