1:1 - esaj-ajuizamento
Tipo requisição: POST;
Tipo resposta: ASSÍNCRONA;
Uma execução 1:1 executa apenas um item e entrega assíncronamente uma resposta (ou seja, resposta assíncrona).
Antes de mais nada, é importante entender o conceito de que muitas das chamadas na API da Oystr retornam respostas de maneira assíncrona. Isso quer dizer que a resposta da chamada não estará pronta de imediato e você receberá um id para consultar posteriormente. O design da API leva em consideração o tempo que os robôs demoram para executar uma determinada tarefa. O retorno de um método assíncrono é um json com um único campo: id.
Abaixo, seguem os parâmetros do header e do body (JSON que precisa ser enviado no body) da requisição necessários enviar, assim como o retorno obtido em caso de sucesso.
| Parâmetro |
Tipo |
Descrição |
| X-Oystr-Timeout |
String (obrigatório) |
Timeout da máximo da operação. Após o término desse tempo, o robô irá retornar um erro de tempo esgotado. Por exemplo: 100s. |
| X-Oystr-Auth |
String (opcional) |
Todas as requisições para nossa API demandam o uso do header X-Oystr-Auth. Ele é obrigatório. Caso o header com o token não seja usado, a retorno do servidor será HTTP/1.1 403 Forbidden, indicando a ausência de permissões para efetuar a requisição. |
Parâmetros do body (objeto json)
| Parâmetro |
Tipo |
Descrição |
| bot |
String (obrigatório) |
Nome/Identificador do robô. |
| version |
String (obrigatório) |
Versão do robô. |
| credentials |
Objeto (opcional) |
Objeto contendo as credenciais de acesso, seja usuário/senha, certificado ou identificador de cofre. Alguns robôs não exigem credenciais, pois são para consulta de dados públicos (não logado). Cada robô pode exigir um tipo de credencial diferente. Veja na seção do robô qual é o modelo exigido. |
| data |
Objeto (obrigatório) |
Objeto contendo os dados para consumo do robô. Cada robô irá pedir dados específicos para sua tarefa. Veja na seção sobre os robôs quais os dados que você irá precisar. |
| files |
Array de Objetos(opcional) |
Array contendo o conteúdo dos arquivos que serão consumidos pelo robô. |
Parâmetros do objeto data (objeto json)
| Parâmetro |
Tipo |
Descrição |
| integracao |
String |
Identificação do processo no sistema do cliente |
| tribunal |
String (obrigatório) |
Sigla do estado que o robo devera fazer o ajuizamento (SP, AM, SC, etc.) |
| foro |
String (obrigatório) |
Foro onde o processo será protocolo |
| competencia |
String (obrigatório) |
Competência do processo (civil, etc.) |
| classe |
String (obrigatório) |
Classificação do processo |
| assuntoPrincipal |
String (obrigatório) |
Assunto princiapl do processo |
| outrosAssuntos |
List |
Outros assuntos |
| pedidoLiminar |
String |
Se o processo é um pedido liminar (sim, não, true, false |
| segredoJustica |
String |
Se o processo será segredo de justica(sim, não, true, false |
| valorAcao |
String (obrigatório) |
Valor da ação |
| sorteio |
String (obrigatório) |
Se o processo será distribuido por sorteio (caso sim, preencher com "DEPENDENCIA") |
| processoRef |
String (obrigatório) |
Referencia do processo |
| fundamento |
String (obrigatório) |
Fundamento do processo |
| pedidoDispensa |
String (obrigatório) |
Se será solicitado pedido de dispensa (sim, não, true, false |
| justicaGratuita |
String (obrigatório) |
Se solicitará justiça gratuita (sim, não, true, false |
| numeroDocumentoDare |
String (obrigatório) |
Numero dare |
| partes |
String (obrigatório) |
Partes do processo (ver definição abaixo) |
| arquivos |
String (obrigatório) |
Arquivos |
Parâmetros do objeto parte (objeto json)
| Parâmetro |
Tipo |
Descrição |
| participacao |
String |
Tipo de participação da parte (REQUERIDO, REQUERENTE, ADVOGADO) |
| tipoParte |
String (obrigatório se não informado o documento) |
Tipo da parte (F, J, FÍSICA, JURÍDICA) |
| nome |
String (obrigatório) |
Nome da parte |
| nomeSocial |
String |
Nome social da parte |
| genero |
String (obrigatório) |
Gênero da parte |
| documento |
String |
Documento da parte |
| idoso |
String |
Se a parte é idosa (sim, não, true, false) |
| rg |
List |
RG da parte |
| emissorRG |
String |
Emissor do RG da parte |
| estadoCivil |
String |
Estado civil da parte |
| nacionalidade |
String |
Nacionalidade da parte |
| profissao |
String |
Profissão da parte |
| email |
String |
Email da parte |
| enderecoParte |
Objeto |
Endereco da parte (ver definicao abaixo) |
Parâmetros do objeto endereco (objeto json)
| Parâmetro |
Tipo |
Descrição |
| cep |
String |
CEP |
| logradouro |
String |
Nome da Rua |
| numero |
String |
Número do endereço |
| complemento |
String |
Complemento |
| bairro |
String |
Bairro |
| estado |
String |
Estado (somente sigla) |
| cidade |
String |
Cidade |
Retorno (objeto json)
| Parâmetro |
Tipo |
Descrição |
| id |
String |
O identificador único para consultar a resposta da chamada assíncrona. |
Exemplo Json
{
"dry": false,
"cid": "",
"bot": "esaj-ajuizamento"
"version": "v3.0.0-dev",
"force": false,
"timeout": "1500000ms",
"data": {
"foro": "Foro de Franca",
"numeroDocumentoDare": "",
"justicaGratuita": "false",
"partes": [
{
"generoParte": "False",
"nomeSocialParte": "Empresa do Marquinhos",
"emissorRG": "",
"nacionalidade": "",
"profissao": "",
"estadoCivil": "",
"enderecoParte": {
"semEndereco": "",
"complemento": false,
"estado": "SP",
"cep": "12345-123",
"bairro": false,
"cidade": "São Paulo",
"logradouro": "Rua do joãozinho",
"numero": "1000"
},
"idoso": "",
"tipoParte": "",
"participacao": "REQUERENTE",
"rg": "",
"documentoParte": "12.123.123/0001-12",
"nomeParte": "Empresa do Marquinhos",
"email": ""
},
{
"generoParte": "Masculino",
"nomeSocialParte": "João da Silva Sauro",
"emissorRG": "",
"nacionalidade": "",
"profissao": "",
"estadoCivil": "",
"enderecoParte": {
"semEndereco": "",
"complemento": false,
"estado": "SP",
"cep": "12345-123",
"bairro": false,
"cidade": "São Paulo",
"logradouro": "Rua do joãozinho",
"numero": "1000"
},
"idoso": "",
"tipoParte": "",
"participacao": "REQUERIDO",
"rg": "",
"documentoParte": " 123.456.789-00",
"nomeParte": "Rodrigo Trindade dos Santos",
"email": ""
}
],
"pedidoDispensa": "false",
"competencia": "Cível",
"segredoJustica": "true",
"assuntoPrincipal": "9582 - Alienação Fiduciária",
"sorteio": "SORTEIO",
"fundamento": "false",
"tribunal": "SP",
"integracao": "",
"processoRef": "false",
"classe": "BUSCA E APREENSÃO EM ALIENAÇÃO FIDUCIÁRIA",
"arquivos": [
{
"peticao": true,
"descricaoArquivo": "Petição",
"arquivo": "100348000009224_7_FRANCA_SP_14082024.pdf",
"tipoArquivo": "Petição",
"sigilo": true
},
{
"peticao": false,
"descricaoArquivo": "Documento para juntada ",
"arquivo": "Procuracao_2023.pdf",
"tipoArquivo": "Procuração",
"sigilo": true
},
{
"peticao": false,
"descricaoArquivo": "Documento para juntada ",
"arquivo": "Estatuto Social 2024.01.10. CFI.pdf",
"tipoArquivo": "Documento 1",
"sigilo": true
}
],
"grau": "primeiro-grau",
"pedidoLiminar": "true",
"valorAcao": "7.624,83"
},
"files": [
{
"property": "arquivo",
"data": "",
"name": "100348000009224_7_FRANCA_SP_14082024.pdf",
"bound": true
},
{
"property": "arquivo",
"data": "",
"name": "Procuracao_2023.pdf",
"bound": true
},
{
"property": "arquivo",
"data": "",
"name": "Estatuto Social 2024.01.10. CFI.pdf",
"bound": true
}
],
"credentials": {
"hash": ""
}
}
