# Documentações de API
# API - cna-consulta-oab
**Formato da Requisição do robô (via HTTP)**
```json
{
"dry": false,
"bot": "cna-consulta-oab",
"version": "v3.0.0-dev",
"cid": "",
"timeout": "",
"deadline": "",
"data": {
"integracao": "",
"inscricao": "51414",
"seccional": "PR",
},
"credentials": {
"username": "",
"pin": "",
"base64Cert": "",
"credentialsOption": ""
}
}
```
**Descrição campos 'DATA'**
| CAMPO | Obrigatório | Formato | Exemplo | Descrição |
|---|
| integracao | Não | String | | Número de controle interno |
| inscricao | Sim | String | | Nº da inscrição da OAB do advogado |
| seccional | Sim | String | (ex. PR, BA, SP) | Informação de qual estado |
# API - proconsumidor-coletar-audiencia
Formato Markdown (documentação simples)
#### Autentica um usuário com CPF e senha codificada.
##### **POST** `/auth/login`
**Requisição:**
**Headers:**
- Content-Type: application/json
**Body:**
```json
{
"login": "12345",
"pass": "e10adc3949ba59abbe56e057f20f883e",
"tokenValidation": "",
"isUsuarioConsumidor": false
}
```
**Descrição dos campos:**
- **login** (string): **CPF** do usuário, apenas números.
- **pass** (string): Senha codificada (ex: **MD5**).
- **tokenValidation** (string): Campo para token externo (pode ficar vazio).
- **isUsuarioConsumidor** (boolean): false para usuários internos, true para consumidores finais.
**Resposta 200 OK**
```json
{
"uid": "MjEXXXz",
"message": "deliverCredentials",
"jsonUser": "{\"codigoUsuario\":XXXXXXX,\"nome\":\"XXXXXXXXXXXXXXX\",\"cpf\":\"XXXXXXXXXX\",\"tipoUsuario\":\"Fornecedor\",\"nomePerfil\":\"Colaborador\",\"codigoTipoUsuario\":4,\"listaFornecedores\":[{\"codigo\":XXXXX,\"nome\":\"XXXXXXXXXXXX\",\"cpfCnpj\":\"XXXXXXXXXXXXXX\"},{\"codigo\":XXX,\"nome\":\"XXXXXXX Financeira\",\"cpfCnpj\":\"XXXXXXXXXX\"},{\"codigo\":XXXXXX,\"nome\":\"XXXXXXXX XXXXXXX\",\"cpfCnpj\":\"XXXXXXXXXX\"}],\"permissoes\":[\"gerenciar_atendimento\",\"relatorio_gerencial\"],\"codigoFornecedor\":XXXX,\"nomeFornecedor\":\"XXXXXXXXXXXXXXXX.\",\"cnpjFornecedor\":XXXXXXXXXXXXXXXXX,\"indicadorAceiteTermoUso\":true}",
"expiry": 1752683825157,
"primeiroAcesso": false,
"auth_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyODM2ODg3MTg0IiwimNvZGlnb0Zvcm5lY2Vkb3IiOjY1NSwiaXNVc3VhcmlvQ29uc3VtaWRvciI6ZmFsc2V9.T1x2r0wcHijQNey_fyjcTs9IUI4Ocwx7-Or7Nu-aYyQ"
}
```
**Respostas possíveis:**
- 401 Unauthorized: CPF ou senha inválidos.
- 500 Internal Server Error: Erro interno.
#### **Altera o fornecedor autenticado associado ao usuário logado.**
##### **PUT** `/login/818/mudar-fornecedor-autenticado`
**Requisição:**
**Headers obrigatórios:**
---
**Body da Requisição (JSON):**
---
**Respostas esperadas:**
| Código | Descrição |
|---|
| 200 | Sucesso na troca do fornecedor |
| 401 | Não autorizado (token inválido) |
| 403 | Acesso negado |
| 500 | Erro interno do servidor |
| Parâmetro | Descrição | Exemplo |
|---|
| `numero` | Número do atendimento ou acompanhamento | XXXXXXXXXXXXXX |
| Código | Descrição |
|---|
| 404 | Atendimento não encontrado |
| 401 | Não autorizado (token inválido) |
| 500 | Erro interno no servidor |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `2XXXXXXXXXXXXXXXXX503` |
Prezados,\n
Lorem Ipsum é simplesmente uma simulação de texto da indústria tipográfica e de impressos, e vem sendo utilizado desde o século XVI, quando um impressor desconhecido pegou uma bandeja de tipos e os embaralhou para fazer um livro de modelos de tipos. Lorem Ipsum sobreviveu não só a cinco séculos, como também ao salto para a editoração eletrônica, permanecendo essencialmente inalterado. Se popularizou na década de 60, quando a Letraset lançou decalques contendo passagens de Lorem Ipsum, e mais recentemente quando passou a ser integrado a softwares de editoração eletrônica como Aldus PageMaker.,\n
\n\n\n\n\n\n\n\n\n\n\n\nMBA\nAdvogados
",
"consideracoesCredenciada": null,
"textoNotificacaoConsumidor": null,
"textoNotificacaoProcurador": null,
"tipoResultado": null,
"codigoFornecedor": 1,
"nomeFornecedor": null,
"codigoConsumidor": 20000000-111,
"nomeConsumidor": "ZXXXXXXXX XXXXXX XX da Silva ",
"dataRetornoConsumidor": 1726282800000,
"codigoProcurador": null,
"nomeProcurador": null,
"indicadorDescumprimentoAcordo": null,
"fornecedores": [
{
"textoNotificacao": "TERMO DE NOTIFICAÇÃO - CARTA ELETRÔNICA
Número de Atendimento: 2407072600100050301
Lorem Ipsum é simplesmente uma simulação de texto da indústria tipográfica e de impressos, e vem sendo utilizado desde o século XVI, quando um impressor desconhecido pegou uma bandeja de tipos e os embaralhou para fazer um livro de modelos de tipos. Lorem Ipsum sobreviveu não só a cinco séculos, como também ao salto para a editoração eletrônica, permanecendo essencialmente inalterado. Se popularizou na década de 60, quando a Letraset lançou decalques contendo passagens de Lorem Ipsum, e mais recentemente quando passou a ser integrado a softwares de editoração eletrônica como Aldus PageMaker. termos dos artigos 45, 46 e 47 do Decreto 2.181/97, além das possíveis sanções administrativas previstas no Código Defesa do Consumidor e legislações correlatas.
31 de Julho de 2024
",
"dataAvisoRecebimento": null,
"indicadorRespostaFornecedor": true,
"indicadorPrazoProrrogado": false,
"dataPrazoRespostaFornecedor": "2024-08-10",
"indicadorParticipacaoEletronica": true,
"indicadorParticipacaoCancelada": false,
"indicadorAtendimentoEletronico": true,
"respostaFornecedor": {
"data": 1723005879673,
"texto": "Prezados,\n
Segue\ndefesa administrativa referente a reclamação em questão do fornecedor FACTA\nFINANCEIRA S.A. CRÉDITO, FINANCIAMENTO E INVESTIMENTO.
Atenciosamente,\n
\n\n\n\n\n\n\n\n\n\n\n\nMBA\nAdvogados
",
"anexos": [
{
"chavePrimaria": {
"ano": 24,
"mes": 7,
"credenciada": 1461160,
"postoAtendimento": 1461161,
"numeroSequencial": 50,
"dataAbertura": 1722433130149,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 1
},
"nome": "2XXXXXXXXXXXXXXXXXX1 DEFESA ADMINISTRATIVA.pdf",
"dataInclusao": 1723005899531,
"tamanhoArquivo": 241799,
"objectKey": "172XXXXXX31_ee32c_680.pdf",
"tamanhoArquivoStorage": 241799,
"numeroSequencial": 1
},
{
"chavePrimaria": {
"ano": 24,
"mes": 7,
"credenciada": 1461160,
"postoAtendimento": 1461161,
"numeroSequencial": 50,
"dataAbertura": 1722433130149,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 2
},
"nome": "PROCURAÇÃO FACTA.pdf",
"dataInclusao": 1723005905205,
"tamanhoArquivo": 996121,
"objectKey": "172XXXXX205_c3e5f_68b.pdf",
"tamanhoArquivoStorage": 996121,
"numeroSequencial": 2
}
]
},
"numeroFornecedorAtendimento": 1
}
],
"fornecedoresDetails": [
{
"codigoFornecedor": 8XX,
"numeroFornecedorAtendimento": 1,
"nome": "Facta Financeira",
"numeroAtendimentoFormatado": "2X.XX.XXXX.XXX.XXXXX-XXX",
"indicadorAtendimentoEletronico": true,
"indicadorSuspensaoAtendimentoEletronico": false,
"atendimentoCancelado": false,
"telefones": [
{
"codigo": 3,
"codigoArea": "51",
"telefone": "3XXXXX8",
"tipo": {
"codigoTipoTelefone": 6,
"nomeTipoTelefone": "Institucional"
}
},
{
"codigo": 4,
"codigoArea": "61",
"telefone": "9XXXXXXX8",
"tipo": {
"codigoTipoTelefone": 2,
"nomeTipoTelefone": "Celular"
}
}
]
}
]
}
],
"responseAttrs": {}
}
```
---
**Respostas esperadas:**
| Código | Descrição |
|---|
| 400 | Erro de parâmetros |
| 401 | Não autorizado |
| 500 | Erro interno |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `24070726001000503` |
| `dataAbertura` | string | ✅ Sim | Data de abertura no formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss | 2024-07-08 ou 2024-07-08T10:00:00 |
**Headers Obrigatórios**
| Código HTTP | Descrição |
|---|
| `401` | Não autorizado (token inválido/expirado) |
| `403` | Acesso negado |
| `404` | Audiência não encontrada |
| `500` | Erro interno no servidor |
| Código | Descrição |
|---|
| 200 | Sucesso na troca do fornecedor |
| 401 | Não autorizado (token inválido) |
| 403 | Acesso negado |
| 500 | Erro interno do servidor |
| Parâmetro | Descrição | Exemplo |
|---|
| `numero` | Número do atendimento ou acompanhamento | XXXXXXXXXXXXXX |
| Código | Descrição |
|---|
| 404 | Atendimento não encontrado |
| 401 | Não autorizado (token inválido) |
| 500 | Erro interno no servidor |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `2XXXXXXXXXXXXXXXXX503` |
but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
Pelo exposto, recorre a este PROCON.
",
"numeroAcompanhamento": "2XXXXXXXXXXXXX3",
"dataAbertura": 1719508292080,
"horaEntrada": null,
"tipoAcompanhamento": {
"codigo": 3,
"nome": "Reclamação",
"descricao": "Reclamação"
},
"tipoOrigemAcompanhamento": {
"codigo": 1,
"nome": "Presencial",
"descricao": "Presencial"
},
"tipoConsulta": null,
"andamentos": [
{
"chavePrimaria": {
"numeroAndamentoAcompanhamento": 3XXXX2,
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 120540,
"postoAtendimento": 111431,
"numeroSequencial": X60,
"numeroAcompanhamento": "2XXXXXXXXXXXXXX3"
}
},
"andamento": {
"codigo": 392,
"nome": "Prazo Expirado para a Fase Decisão",
"codigoInterno": 60,
"indicadorAndamentoManual": false,
"chavePrimaria": 3012
},
"usuario": {
"codigo": 0,
"nome": "Usuário Sistema"
},
"andamentosAtendimento": [
{
"numeroAtendimentoFormatado": "2XX.XX6.03XX.00XXXX1.00XX6-3,
"numeroFornecedorAtendimento": 1,
"codigoFornecedor": 818,
"nomeFornecedor": "XXXa FXXXceira"
}
],
"data": 1751105447453,
"acompanhamento": {
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 210454,
"postoAtendimento": 102121,
"numeroSequencial": 541
},
"indicadorAtendimentoPreferencial": true,
"tipoAcompanhamento": {
"codigo": 3,
"nome": "Reclamação",
"descricao": "Reclamação"
},
"tipoOrigemAcompanhamento": {
"codigo": 1,
"nome": "Presencial",
"descricao": "Presencial"
},
"tipoFaseAcompanhamento": {
"codigo": 4,
"nome": "Finalizada",
"descricao": "Finalizada"
},
"numeroAcompanhamento": 24XXXXXXXXX3,
"textoAcompanhamento": " but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
Pelo exposto, recorre a este PROCON.
",
"dataInclusao": 1719508292080,
"dataInclusaoDecisao": null,
"dataLiberacaoAtendimento": null,
"usuarioAbertura": 1XXXX06,
"numeroAtendimentoFormatado": null,
"fornecedores": null,
"areaAtendimento": null,
"assuntoAtendimento": null,
"problemaAtendimento": null,
"comoComprou": null,
"textoReclamacao": " but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
",
"dataPrazoFinalizacao": 1750993200000,
"dataPrazoFaseTratativa": "2024-10-25",
"codigoCredenciada": 186030,
"codigoPostoAtendimento": 186031,
"numeroAcompanhamentoFormatado": "2XX.XX6.03XX.00XXXX1.00XX6-3",
"numeroAcompanhamentoString": "24XXXXXXXXX3",
"abertaOuTratativa": false,
"tratativa": false,
"denuncia": false,
"reclamacao": true,
"numeroAtendimentoAcompanhamentoFormatado": "2XX.XX6.03XX.00XXXX1.00XX6-3",
"consulta": false
}
},
],
"atendimentos": [
{
"chavePrimaria": {
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 186030,
"postoAtendimento": 186031,
"numeroSequencial": 176,
"numeroAcompanhamento": "24060317001001763"
},
"numeroFornecedorAtendimento": 1
},
"fornecedor": {
"codigo": 001,
"tipoCadastro": {
"codigoTipoCadastro": 3,
"nomeTipoCadastro": "Fornecedor"
},
"tipoEstadoCadastro": {
"codigoEstadoCadastro": 1,
"nomeEstadoCadastro": "Ativo"
},
"nomeCadastro": "FXXXX FiXXXXra S.A. Credito, FinaXXXXmento e InvXXXXmento",
"complementoEndereco": "1XX9 - salas 7XXX1 e 7XX02",
"cep": {
"operacao": null,
"nrCep": 9XXXX11,
"uf": "RS",
"localidade": {
"operacao": null,
"numeroLocalidade": XXX,
"uf": "RS",
"nomeLocalidade": "PXXo AlXXXe",
"cep": null,
"situacaoCodificacaoLogradouro": 1,
"tipoLocalidade": "M",
"numeroLocalidadeSubordinacao": null,
"abreviacaoNomeLocalidade": "Pto Alegre",
"codigoIBGEMunicipio": "431XXXX4902",
"chavePrimaria": XXX,
"operacaoRemocao": false,
"operacaoInclusao": false,
"operacaoAlteracao": false,
"operacaoInclusaoOuAlteracao": false
},
"codigoLocalidade": XXX,
"bairro": {
"operacao": null,
"codigo": 1XXX75,
"uf": "RS",
"localidade": 7XX4,
"nomeBairro": "Centro Histórico",
"nomeBairroAbreviado": "C Histórico",
"chavePrimaria": 1XXX5,
"operacaoRemocao": false,
"operacaoInclusao": false,
"operacaoAlteracao": false,
"operacaoInclusaoOuAlteracao": false
},
"codigoBairro": XX,
"logradouro": "RXX dos AndXXXXXas",
"complementoLogradouro": "- de 1XX1 a 15XXX7 - lado ímpar",
"nome": null,
"indicadorCepAtivo": true,
"nrCepAnteior": null,
"chavePrimaria": 9XXXXXXX,
"cep": "90020011",
"operacaoRemocao": false,
"operacaoInclusao": false,
"operacaoAlteracao": false,
"operacaoInclusaoOuAlteracao": false
},
"listaAnexo": [
{
"chavePrimaria": {
"codigo": 1,
"cadastro": 818
},
"nome": "FXXX FiXXXXra.pdf",
"dataInclusao": 1687459098138,
"operacao": null,
"usuario": {
"codigo": 1XX51,
"nome": "IXXXXXa AXXes CXXXrgo"
},
"tamanhoArquivo": 177365,
"indicadorAnexoPublico": null,
"objectKey": "1687459098138_d4e02_433.pdf",
"tamanhoArquivoStorage": 177365
}
],
"listaEmail": [
{
"chavePrimaria": {
"codigo": 7,
"cadastro": 818
},
"texto": "adm.contestacao@ercobranca.com.br",
"tipoEmail": {
"codigoTipoEmail": 4,
"nomeTipoEmail": "Alerta de Notificação"
},
"emailAlertaNotificacao": true,
"emailPrincipal": false,
"emailInstitucional": false
},
{
"chavePrimaria": {
"codigo": 8,
"cadastro": 818
},
"texto": "everton.medeiros@ercobranca.com.br",
"tipoEmail": {
"codigoTipoEmail": 3,
"nomeTipoEmail": "Ponto Focal"
},
"emailAlertaNotificacao": false,
"emailPrincipal": false,
"emailInstitucional": false
},
{
"chavePrimaria": {
"codigo": 10,
"cadastro": 818
},
"texto": "adm.contestacao@ercobranca.com.br",
"tipoEmail": {
"codigoTipoEmail": 2,
"nomeTipoEmail": "Institucional"
},
"emailAlertaNotificacao": false,
"emailPrincipal": false,
"emailInstitucional": true
}
],
"listaTelefone": [
{
"chavePrimaria": {
"codigo": 3,
"cadastro": 818
},
"codigoArea": "51",
"telefone": "30217838",
"tipoTelefone": {
"codigoTipoTelefone": 6,
"nomeTipoTelefone": "Institucional"
},
"telefonePrincipal": false,
"telefoneInstitucional": true
},
{
"chavePrimaria": {
"codigo": 4,
"cadastro": 818
},
"codigoArea": "61",
"telefone": "998552188",
"tipoTelefone": {
"codigoTipoTelefone": 2,
"nomeTipoTelefone": "Celular"
},
"telefonePrincipal": false,
"telefoneInstitucional": false
}
],
"nomeLogradouro": "Rua dos Andradas",
"nomeBairro": "Centro Histórico",
"tipoPessoa": {
"codigoTipoPessoa": 2,
"nomeTipoPessoa": "Jurídica"
},
"urlSite": "www.factafinanceira.com.br",
"dataCriacao": 1572017818000,
"indicadorAtendimentoEletronico": true,
"indicadorSuspensaoAtendimentoEletronico": false,
"indicadorPresencaConsumidorGov": true,
"credenciada": 1,
"listaCategoriaFornecedor": [
{
"chavePrimaria": {
"cadastroFornecedor": 818,
"categoria": {
"chavePrimaria": {
"codigo": 576,
"tipoCategoria": {
"codigo": 5,
"nome": "Segmento"
}
},
"nome": "Bancos, Financeiras e Administradoras de Cartão",
"ativo": true
}
}
}
],
"dataLimiteAlteracaoAuditor": 1572017818000,
"dataLimiteAlteracaoTecnicoCredenciada": 1572017818000,
"existeEnderecoCorrespondenciaCriadoPelaSenacon": false,
"dataEliminacao": null,
"dataDesativacao": null,
"indicadorSeloSenacon": true,
"dataHabilitacaoEletronica": 1649272623027,
"dataDesabilitacaoEletronica": null,
"dataSuspensaoEletronica": null,
"inclusao": false,
"cnpj": 15581638000130,
"nomeFantasia": "Facta Financeira",
"cnaePrincipal": {
"codigo": 6436100,
"descricao": "SOCIEDADES DE CREDITO, FINANCIAMENTO E INVESTIMENTO - FINANCEIRAS",
"chavePrimaria": 6436100,
"codigoFormatado": "6436-1/00"
},
"indicadorEmailAlertaNotificacao": null,
"fornecedorPrincipal": null,
"cpf": null,
"nomeFantasiaOuRazaoSocial": "Facta Financeira",
"chavePrimaria": 818,
"ativo": true
},
"fornecedores": [],
"indicadorFornecedorProcurado": true,
"tipoEstadoAtendimento": {
"codigo": 30,
"nome": "Prazo Expirado",
"codigoFase": 4,
"tratativa": false,
"descricao": "Prazo Expirado"
},
"textoContatoFornecedor": null,
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 254154,
"postoAtendimento": 185531,
"numeroSequencial": 356,
"numeroAcompanhamento": "2XXX545XXX01"
},
"existeTrativaFinalizada": true,
"numeroAtendimentoFormatado": "XX.0X.0XXXX.0XX1.0XXX6-3XX",
"numeroFornecedorAtendimento": 1,
"numeroAtendimento": 2XXX545XXX01
}
],
"anexos": [
{
"chavePrimaria": {
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 25454,
"postoAtendimento": 12545,
"numeroSequencial": 155,
"numeroAcompanhamento": "54545445545"
},
"numeroAnexoAcompanhamento": 2
},
"usuario": {
"codigo": 108006,
"nome": "GXXXXa NaXXXia TXXXio"
},
"indicadorAnexoPublico": false,
"nome": "1868 - CXXXE DO PORTO, SC.pdf",
"tamanhoArquivo": 1270990,
"dataInclusao": 1720639099160,
"objectKey": "1720639099160_be486_3ed.pdf",
"tamanhoArquivoStorage": 1270990
},
{
"chavePrimaria": {
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 23641,
"postoAtendimento": 10140,
"numeroSequencial": 216,
"numeroAcompanhamento": "2XXXXXX1001XXX"
},
"numeroAnexoAcompanhamento": 1
},
"usuario": {
"codigo": 108006,
"nome": "GXXXXca NXXXXia TXXvXXo"
},
"indicadorAnexoPublico": false,
"nome": "Documentos Escaneados (2).pdf",
"tamanhoArquivo": 333430,
"dataInclusao": 1719508692184,
"objectKey": "1719508692184_4123a_11b.pdf",
"tamanhoArquivoStorage": 333430
}
],
"anotacoes": [],
"categorias": [
{
"codigo": 39,
"codigoTipo": 6,
"nomeTipo": null,
"nome": "Não comprei / contratrei",
"texto": null,
"tipoRevisao": null
},
{
"codigo": 571,
"codigoTipo": 1,
"nomeTipo": null,
"nome": "Serviços Financeiros",
"texto": null,
"tipoRevisao": null
},
{
"codigo": 817,
"codigoTipo": 2,
"nomeTipo": null,
"nome": "Crédito Consignado / Cartão de Crédito Consignado / RMC (para beneficiários do INSS)",
"texto": null,
"tipoRevisao": null
},
{
"codigo": 847,
"codigoTipo": 4,
"nomeTipo": null,
"nome": "Cartão não solicitado - Envio ou cobrança",
"texto": null,
"tipoRevisao": null
}
],
"vinculoReclamacaoOficio": [],
"consumidor": {
"codigo": 125452,
"nome": null,
"nomeSocial": null,
"sexo": null,
"telefone": null,
"email": null,
"tipoPessoa": {
"codigoTipoPessoa": 1,
"nomeTipoPessoa": "Física",
"descricao": "Física"
},
"tipoConsumidorPessoaFisica": {
"codigoTipoConsumidorPessoaFisica": 2,
"nomeTipoConsumidorPessoaFisica": "Nacional",
"codigo": 2,
"descricao": "Nacional"
},
"procurador": false,
"anonimo": false,
"consumidorSemCpf": false,
"cpfCnpj": null,
"endereco": null
},
"procurador": null,
"nomeFornecedores": null,
"nomeFantasiaFornecedor": null,
"arquivoCalculo": null,
"indicadorCalculoSolicitado": null,
"codigoUsuarioAbertura": 21501,
"nomeUsuarioAbertura": "GXXXX NaXXa TrXXXXo",
"indicadorProximoFila": null,
"indicadorBloqueio": null,
"indicadorDisponivelParaDistribuicao": false,
"textoReclamacao": " but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
",
"existeAoMenosUmaTratativaFinalizada": true,
"indicadorExistenciaTratativa": true,
"protocoloConsumidorGov": null,
"setorDistribuicao": "",
"dataInclusaoDecisao": null,
"categoriaArea": null,
"categoriaAssunto": null,
"categoriaProblema": null
},
"responseAttrs": {}
}
```
---
**Respostas esperadas:**
| Código | Descrição |
|---|
| 400 | Erro de parâmetros |
| 401 | Não autorizado |
| 500 | Erro interno |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `24070726001000503` |
**Headers Obrigatórios**
TERMO DE NOTIFICAÇÃO - CARTA ELETRÔNICA
Número de Atendimento: 2406031700100176301
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum., além das possíveis sanções administrativas previstas no Código Defesa do Consumidor e legislações correlatas.
10 de Julho de 2024
",
"dataAvisoRecebimento": null,
"indicadorRespostaFornecedor": true,
"indicadorPrazoProrrogado": false,
"dataPrazoRespostaFornecedor": "2024-07-20",
"indicadorParticipacaoEletronica": true,
"indicadorParticipacaoCancelada": false,
"indicadorAtendimentoEletronico": true,
"respostaFornecedor": {
"data": 1721151781641,
"texto": "",
"anexos": [
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 10000210,
"postoAtendimento": 25451,
"numeroSequencial": 176,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 1
},
"nome": "DEFESA ADMINISTRATIVA PEDRO.pdf",
"dataInclusao": 1721151769225,
"tamanhoArquivo": 312446,
"objectKey": "1721769225_661e1_251.pdf",
"tamanhoArquivoStorage": 312446,
"numeroSequencial": 1
},
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 22000,
"postoAtendimento": 55441,
"numeroSequencial": 364,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 2
},
"nome": "PROCURAÇÃO FXXXX PXXXXON - Copia.pdf",
"dataInclusao": 1721151818284,
"tamanhoArquivo": 1708876,
"objectKey": "172XX1818284_da873_30e.pdf",
"tamanhoArquivoStorage": 1708876,
"numeroSequencial": 2
}
]
},
"numeroFornecedorAtendimento": 1
}
],
"fornecedoresDetails": null
},
"responseAttrs": {}
}
```
**Respostas possíveis**
| Código HTTP | Descrição |
|---|
| `401` | Não autorizado (token inválido/expirado) |
| `403` | Acesso negado |
| `404` | Protocolo não encontrada |
| `500` | Erro interno no servidor |
| Código | Descrição |
|---|
| 200 | Sucesso na troca do fornecedor |
| 401 | Não autorizado (token inválido) |
| 403 | Acesso negado |
| 500 | Erro interno do servidor |
| Parâmetro | Descrição | Exemplo |
|---|
| `numero` | Número do atendimento ou acompanhamento | XXXXXXXXXXXXXX |
| Código | Descrição |
|---|
| 404 | Atendimento não encontrado |
| 401 | Não autorizado (token inválido) |
| 500 | Erro interno no servidor |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `2XXXXXXXXXXXXXXXXX503` |
Prezados,\n
Lorem Ipsum é simplesmente uma simulação de texto da indústria tipográfica e de impressos, e vem sendo utilizado desde o século XVI, quando um impressor desconhecido pegou uma bandeja de tipos e os embaralhou para fazer um livro de modelos de tipos. Lorem Ipsum sobreviveu não só a cinco séculos, como também ao salto para a editoração eletrônica, permanecendo essencialmente inalterado. Se popularizou na década de 60, quando a Letraset lançou decalques contendo passagens de Lorem Ipsum, e mais recentemente quando passou a ser integrado a softwares de editoração eletrônica como Aldus PageMaker.,\n
\n\n\n\n\n\n\n\n\n\n\n\nMBA\nAdvogados
",
"consideracoesCredenciada": null,
"textoNotificacaoConsumidor": null,
"textoNotificacaoProcurador": null,
"tipoResultado": null,
"codigoFornecedor": 1,
"nomeFornecedor": null,
"codigoConsumidor": 20000000-111,
"nomeConsumidor": "ZXXXXXXXX XXXXXX XX da Silva ",
"dataRetornoConsumidor": 1726282800000,
"codigoProcurador": null,
"nomeProcurador": null,
"indicadorDescumprimentoAcordo": null,
"fornecedores": [
{
"textoNotificacao": "TERMO DE NOTIFICAÇÃO - CARTA ELETRÔNICA
Número de Atendimento: 2407072600100050301
Lorem Ipsum é simplesmente uma simulação de texto da indústria tipográfica e de impressos, e vem sendo utilizado desde o século XVI, quando um impressor desconhecido pegou uma bandeja de tipos e os embaralhou para fazer um livro de modelos de tipos. Lorem Ipsum sobreviveu não só a cinco séculos, como também ao salto para a editoração eletrônica, permanecendo essencialmente inalterado. Se popularizou na década de 60, quando a Letraset lançou decalques contendo passagens de Lorem Ipsum, e mais recentemente quando passou a ser integrado a softwares de editoração eletrônica como Aldus PageMaker. termos dos artigos 45, 46 e 47 do Decreto 2.181/97, além das possíveis sanções administrativas previstas no Código Defesa do Consumidor e legislações correlatas.
31 de Julho de 2024
",
"dataAvisoRecebimento": null,
"indicadorRespostaFornecedor": true,
"indicadorPrazoProrrogado": false,
"dataPrazoRespostaFornecedor": "2024-08-10",
"indicadorParticipacaoEletronica": true,
"indicadorParticipacaoCancelada": false,
"indicadorAtendimentoEletronico": true,
"respostaFornecedor": {
"data": 1723005879673,
"texto": "Prezados,\n
Segue\ndefesa administrativa referente a reclamação em questão do fornecedor FACTA\nFINANCEIRA S.A. CRÉDITO, FINANCIAMENTO E INVESTIMENTO.
Atenciosamente,\n
\n\n\n\n\n\n\n\n\n\n\n\nMBA\nAdvogados
",
"anexos": [
{
"chavePrimaria": {
"ano": 24,
"mes": 7,
"credenciada": 1461160,
"postoAtendimento": 1461161,
"numeroSequencial": 50,
"dataAbertura": 1722433130149,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 1
},
"nome": "2XXXXXXXXXXXXXXXXXX1 DEFESA ADMINISTRATIVA.pdf",
"dataInclusao": 1723005899531,
"tamanhoArquivo": 241799,
"objectKey": "172XXXXXX31_ee32c_680.pdf",
"tamanhoArquivoStorage": 241799,
"numeroSequencial": 1
},
{
"chavePrimaria": {
"ano": 24,
"mes": 7,
"credenciada": 1461160,
"postoAtendimento": 1461161,
"numeroSequencial": 50,
"dataAbertura": 1722433130149,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 2
},
"nome": "PROCURAÇÃO FACTA.pdf",
"dataInclusao": 1723005905205,
"tamanhoArquivo": 996121,
"objectKey": "172XXXXX205_c3e5f_68b.pdf",
"tamanhoArquivoStorage": 996121,
"numeroSequencial": 2
}
]
},
"numeroFornecedorAtendimento": 1
}
],
"fornecedoresDetails": [
{
"codigoFornecedor": 8XX,
"numeroFornecedorAtendimento": 1,
"nome": "Facta Financeira",
"numeroAtendimentoFormatado": "2X.XX.XXXX.XXX.XXXXX-XXX",
"indicadorAtendimentoEletronico": true,
"indicadorSuspensaoAtendimentoEletronico": false,
"atendimentoCancelado": false,
"telefones": [
{
"codigo": 3,
"codigoArea": "51",
"telefone": "3XXXXX8",
"tipo": {
"codigoTipoTelefone": 6,
"nomeTipoTelefone": "Institucional"
}
},
{
"codigo": 4,
"codigoArea": "61",
"telefone": "9XXXXXXX8",
"tipo": {
"codigoTipoTelefone": 2,
"nomeTipoTelefone": "Celular"
}
}
]
}
]
}
],
"responseAttrs": {}
}
```
---
**Respostas esperadas:**
| Código | Descrição |
|---|
| 400 | Erro de parâmetros |
| 401 | Não autorizado |
| 500 | Erro interno |
| Código HTTP | Descrição |
|---|
| `401` | Não autorizado (token inválido/expirado) |
| `403` | Acesso negado |
| `404` | Audiência não encontrada |
| `500` | Erro interno no servidor |
| Código | Descrição |
|---|
| 200 | Sucesso na troca do fornecedor |
| 401 | Não autorizado (token inválido) |
| 403 | Acesso negado |
| 500 | Erro interno do servidor |
| Parâmetro | Descrição | Exemplo |
|---|
| `numero` | Número do atendimento ou acompanhamento | XXXXXXXXXXXXXX |
| Código | Descrição |
|---|
| 404 | Atendimento não encontrado |
| 401 | Não autorizado (token inválido) |
| 500 | Erro interno no servidor |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `2XXXXXXXXXXXXXXXXX503` |
but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
Pelo exposto, recorre a este PROCON.
",
"numeroAcompanhamento": "2XXXXXXXXXXXXX3",
"dataAbertura": 1719508292080,
"horaEntrada": null,
"tipoAcompanhamento": {
"codigo": 3,
"nome": "Reclamação",
"descricao": "Reclamação"
},
"tipoOrigemAcompanhamento": {
"codigo": 1,
"nome": "Presencial",
"descricao": "Presencial"
},
"tipoConsulta": null,
"andamentos": [
{
"chavePrimaria": {
"numeroAndamentoAcompanhamento": 3XXXX2,
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 120540,
"postoAtendimento": 111431,
"numeroSequencial": X60,
"numeroAcompanhamento": "2XXXXXXXXXXXXXX3"
}
},
"andamento": {
"codigo": 392,
"nome": "Prazo Expirado para a Fase Decisão",
"codigoInterno": 60,
"indicadorAndamentoManual": false,
"chavePrimaria": 3012
},
"usuario": {
"codigo": 0,
"nome": "Usuário Sistema"
},
"andamentosAtendimento": [
{
"numeroAtendimentoFormatado": "2XX.XX6.03XX.00XXXX1.00XX6-3,
"numeroFornecedorAtendimento": 1,
"codigoFornecedor": 818,
"nomeFornecedor": "XXXa FXXXceira"
}
],
"data": 1751105447453,
"acompanhamento": {
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 210454,
"postoAtendimento": 102121,
"numeroSequencial": 541
},
"indicadorAtendimentoPreferencial": true,
"tipoAcompanhamento": {
"codigo": 3,
"nome": "Reclamação",
"descricao": "Reclamação"
},
"tipoOrigemAcompanhamento": {
"codigo": 1,
"nome": "Presencial",
"descricao": "Presencial"
},
"tipoFaseAcompanhamento": {
"codigo": 4,
"nome": "Finalizada",
"descricao": "Finalizada"
},
"numeroAcompanhamento": 24XXXXXXXXX3,
"textoAcompanhamento": " but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
Pelo exposto, recorre a este PROCON.
",
"dataInclusao": 1719508292080,
"dataInclusaoDecisao": null,
"dataLiberacaoAtendimento": null,
"usuarioAbertura": 1XXXX06,
"numeroAtendimentoFormatado": null,
"fornecedores": null,
"areaAtendimento": null,
"assuntoAtendimento": null,
"problemaAtendimento": null,
"comoComprou": null,
"textoReclamacao": " but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
",
"dataPrazoFinalizacao": 1750993200000,
"dataPrazoFaseTratativa": "2024-10-25",
"codigoCredenciada": 186030,
"codigoPostoAtendimento": 186031,
"numeroAcompanhamentoFormatado": "2XX.XX6.03XX.00XXXX1.00XX6-3",
"numeroAcompanhamentoString": "24XXXXXXXXX3",
"abertaOuTratativa": false,
"tratativa": false,
"denuncia": false,
"reclamacao": true,
"numeroAtendimentoAcompanhamentoFormatado": "2XX.XX6.03XX.00XXXX1.00XX6-3",
"consulta": false
}
},
],
"atendimentos": [
{
"chavePrimaria": {
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 186030,
"postoAtendimento": 186031,
"numeroSequencial": 176,
"numeroAcompanhamento": "24060317001001763"
},
"numeroFornecedorAtendimento": 1
},
"fornecedor": {
"codigo": 001,
"tipoCadastro": {
"codigoTipoCadastro": 3,
"nomeTipoCadastro": "Fornecedor"
},
"tipoEstadoCadastro": {
"codigoEstadoCadastro": 1,
"nomeEstadoCadastro": "Ativo"
},
"nomeCadastro": "FXXXX FiXXXXra S.A. Credito, FinaXXXXmento e InvXXXXmento",
"complementoEndereco": "1XX9 - salas 7XXX1 e 7XX02",
"cep": {
"operacao": null,
"nrCep": 9XXXX11,
"uf": "RS",
"localidade": {
"operacao": null,
"numeroLocalidade": XXX,
"uf": "RS",
"nomeLocalidade": "PXXo AlXXXe",
"cep": null,
"situacaoCodificacaoLogradouro": 1,
"tipoLocalidade": "M",
"numeroLocalidadeSubordinacao": null,
"abreviacaoNomeLocalidade": "Pto Alegre",
"codigoIBGEMunicipio": "431XXXX4902",
"chavePrimaria": XXX,
"operacaoRemocao": false,
"operacaoInclusao": false,
"operacaoAlteracao": false,
"operacaoInclusaoOuAlteracao": false
},
"codigoLocalidade": XXX,
"bairro": {
"operacao": null,
"codigo": 1XXX75,
"uf": "RS",
"localidade": 7XX4,
"nomeBairro": "Centro Histórico",
"nomeBairroAbreviado": "C Histórico",
"chavePrimaria": 1XXX5,
"operacaoRemocao": false,
"operacaoInclusao": false,
"operacaoAlteracao": false,
"operacaoInclusaoOuAlteracao": false
},
"codigoBairro": XX,
"logradouro": "RXX dos AndXXXXXas",
"complementoLogradouro": "- de 1XX1 a 15XXX7 - lado ímpar",
"nome": null,
"indicadorCepAtivo": true,
"nrCepAnteior": null,
"chavePrimaria": 9XXXXXXX,
"cep": "90020011",
"operacaoRemocao": false,
"operacaoInclusao": false,
"operacaoAlteracao": false,
"operacaoInclusaoOuAlteracao": false
},
"listaAnexo": [
{
"chavePrimaria": {
"codigo": 1,
"cadastro": 818
},
"nome": "FXXX FiXXXXra.pdf",
"dataInclusao": 1687459098138,
"operacao": null,
"usuario": {
"codigo": 1XX51,
"nome": "IXXXXXa AXXes CXXXrgo"
},
"tamanhoArquivo": 177365,
"indicadorAnexoPublico": null,
"objectKey": "1687459098138_d4e02_433.pdf",
"tamanhoArquivoStorage": 177365
}
],
"listaEmail": [
{
"chavePrimaria": {
"codigo": 7,
"cadastro": 818
},
"texto": "adm.contestacao@ercobranca.com.br",
"tipoEmail": {
"codigoTipoEmail": 4,
"nomeTipoEmail": "Alerta de Notificação"
},
"emailAlertaNotificacao": true,
"emailPrincipal": false,
"emailInstitucional": false
},
{
"chavePrimaria": {
"codigo": 8,
"cadastro": 818
},
"texto": "everton.medeiros@ercobranca.com.br",
"tipoEmail": {
"codigoTipoEmail": 3,
"nomeTipoEmail": "Ponto Focal"
},
"emailAlertaNotificacao": false,
"emailPrincipal": false,
"emailInstitucional": false
},
{
"chavePrimaria": {
"codigo": 10,
"cadastro": 818
},
"texto": "adm.contestacao@ercobranca.com.br",
"tipoEmail": {
"codigoTipoEmail": 2,
"nomeTipoEmail": "Institucional"
},
"emailAlertaNotificacao": false,
"emailPrincipal": false,
"emailInstitucional": true
}
],
"listaTelefone": [
{
"chavePrimaria": {
"codigo": 3,
"cadastro": 818
},
"codigoArea": "51",
"telefone": "30217838",
"tipoTelefone": {
"codigoTipoTelefone": 6,
"nomeTipoTelefone": "Institucional"
},
"telefonePrincipal": false,
"telefoneInstitucional": true
},
{
"chavePrimaria": {
"codigo": 4,
"cadastro": 818
},
"codigoArea": "61",
"telefone": "998552188",
"tipoTelefone": {
"codigoTipoTelefone": 2,
"nomeTipoTelefone": "Celular"
},
"telefonePrincipal": false,
"telefoneInstitucional": false
}
],
"nomeLogradouro": "Rua dos Andradas",
"nomeBairro": "Centro Histórico",
"tipoPessoa": {
"codigoTipoPessoa": 2,
"nomeTipoPessoa": "Jurídica"
},
"urlSite": "www.factafinanceira.com.br",
"dataCriacao": 1572017818000,
"indicadorAtendimentoEletronico": true,
"indicadorSuspensaoAtendimentoEletronico": false,
"indicadorPresencaConsumidorGov": true,
"credenciada": 1,
"listaCategoriaFornecedor": [
{
"chavePrimaria": {
"cadastroFornecedor": 818,
"categoria": {
"chavePrimaria": {
"codigo": 576,
"tipoCategoria": {
"codigo": 5,
"nome": "Segmento"
}
},
"nome": "Bancos, Financeiras e Administradoras de Cartão",
"ativo": true
}
}
}
],
"dataLimiteAlteracaoAuditor": 1572017818000,
"dataLimiteAlteracaoTecnicoCredenciada": 1572017818000,
"existeEnderecoCorrespondenciaCriadoPelaSenacon": false,
"dataEliminacao": null,
"dataDesativacao": null,
"indicadorSeloSenacon": true,
"dataHabilitacaoEletronica": 1649272623027,
"dataDesabilitacaoEletronica": null,
"dataSuspensaoEletronica": null,
"inclusao": false,
"cnpj": 15581638000130,
"nomeFantasia": "Facta Financeira",
"cnaePrincipal": {
"codigo": 6436100,
"descricao": "SOCIEDADES DE CREDITO, FINANCIAMENTO E INVESTIMENTO - FINANCEIRAS",
"chavePrimaria": 6436100,
"codigoFormatado": "6436-1/00"
},
"indicadorEmailAlertaNotificacao": null,
"fornecedorPrincipal": null,
"cpf": null,
"nomeFantasiaOuRazaoSocial": "Facta Financeira",
"chavePrimaria": 818,
"ativo": true
},
"fornecedores": [],
"indicadorFornecedorProcurado": true,
"tipoEstadoAtendimento": {
"codigo": 30,
"nome": "Prazo Expirado",
"codigoFase": 4,
"tratativa": false,
"descricao": "Prazo Expirado"
},
"textoContatoFornecedor": null,
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 254154,
"postoAtendimento": 185531,
"numeroSequencial": 356,
"numeroAcompanhamento": "2XXX545XXX01"
},
"existeTrativaFinalizada": true,
"numeroAtendimentoFormatado": "XX.0X.0XXXX.0XX1.0XXX6-3XX",
"numeroFornecedorAtendimento": 1,
"numeroAtendimento": 2XXX545XXX01
}
],
"anexos": [
{
"chavePrimaria": {
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 25454,
"postoAtendimento": 12545,
"numeroSequencial": 155,
"numeroAcompanhamento": "54545445545"
},
"numeroAnexoAcompanhamento": 2
},
"usuario": {
"codigo": 108006,
"nome": "GXXXXa NaXXXia TXXXio"
},
"indicadorAnexoPublico": false,
"nome": "1868 - CXXXE DO PORTO, SC.pdf",
"tamanhoArquivo": 1270990,
"dataInclusao": 1720639099160,
"objectKey": "1720639099160_be486_3ed.pdf",
"tamanhoArquivoStorage": 1270990
},
{
"chavePrimaria": {
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 23641,
"postoAtendimento": 10140,
"numeroSequencial": 216,
"numeroAcompanhamento": "2XXXXXX1001XXX"
},
"numeroAnexoAcompanhamento": 1
},
"usuario": {
"codigo": 108006,
"nome": "GXXXXca NXXXXia TXXvXXo"
},
"indicadorAnexoPublico": false,
"nome": "Documentos Escaneados (2).pdf",
"tamanhoArquivo": 333430,
"dataInclusao": 1719508692184,
"objectKey": "1719508692184_4123a_11b.pdf",
"tamanhoArquivoStorage": 333430
}
],
"anotacoes": [],
"categorias": [
{
"codigo": 39,
"codigoTipo": 6,
"nomeTipo": null,
"nome": "Não comprei / contratrei",
"texto": null,
"tipoRevisao": null
},
{
"codigo": 571,
"codigoTipo": 1,
"nomeTipo": null,
"nome": "Serviços Financeiros",
"texto": null,
"tipoRevisao": null
},
{
"codigo": 817,
"codigoTipo": 2,
"nomeTipo": null,
"nome": "Crédito Consignado / Cartão de Crédito Consignado / RMC (para beneficiários do INSS)",
"texto": null,
"tipoRevisao": null
},
{
"codigo": 847,
"codigoTipo": 4,
"nomeTipo": null,
"nome": "Cartão não solicitado - Envio ou cobrança",
"texto": null,
"tipoRevisao": null
}
],
"vinculoReclamacaoOficio": [],
"consumidor": {
"codigo": 125452,
"nome": null,
"nomeSocial": null,
"sexo": null,
"telefone": null,
"email": null,
"tipoPessoa": {
"codigoTipoPessoa": 1,
"nomeTipoPessoa": "Física",
"descricao": "Física"
},
"tipoConsumidorPessoaFisica": {
"codigoTipoConsumidorPessoaFisica": 2,
"nomeTipoConsumidorPessoaFisica": "Nacional",
"codigo": 2,
"descricao": "Nacional"
},
"procurador": false,
"anonimo": false,
"consumidorSemCpf": false,
"cpfCnpj": null,
"endereco": null
},
"procurador": null,
"nomeFornecedores": null,
"nomeFantasiaFornecedor": null,
"arquivoCalculo": null,
"indicadorCalculoSolicitado": null,
"codigoUsuarioAbertura": 21501,
"nomeUsuarioAbertura": "GXXXX NaXXa TrXXXXo",
"indicadorProximoFila": null,
"indicadorBloqueio": null,
"indicadorDisponivelParaDistribuicao": false,
"textoReclamacao": " but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
",
"existeAoMenosUmaTratativaFinalizada": true,
"indicadorExistenciaTratativa": true,
"protocoloConsumidorGov": null,
"setorDistribuicao": "",
"dataInclusaoDecisao": null,
"categoriaArea": null,
"categoriaAssunto": null,
"categoriaProblema": null
},
"responseAttrs": {}
}
```
---
**Respostas esperadas:**
| Código | Descrição |
|---|
| 400 | Erro de parâmetros |
| 401 | Não autorizado |
| 500 | Erro interno |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `24070726001000503` |
| `dataAbertura` | string | ✅ Sim | Data de abertura no formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss | 2024-07-08 ou 2024-07-08T10:00:00 |
**Headers Obrigatórios**
TERMO DE NOTIFICAÇÃO - CARTA ELETRÔNICA
Número de Atendimento: 2406031700100176301
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum., além das possíveis sanções administrativas previstas no Código Defesa do Consumidor e legislações correlatas.
10 de Julho de 2024
",
"dataAvisoRecebimento": null,
"indicadorRespostaFornecedor": true,
"indicadorPrazoProrrogado": false,
"dataPrazoRespostaFornecedor": "2024-07-20",
"indicadorParticipacaoEletronica": true,
"indicadorParticipacaoCancelada": false,
"indicadorAtendimentoEletronico": true,
"respostaFornecedor": {
"data": 1721151781641,
"texto": "",
"anexos": [
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 10000210,
"postoAtendimento": 25451,
"numeroSequencial": 176,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 1
},
"nome": "DEFESA ADMINISTRATIVA PEDRO.pdf",
"dataInclusao": 1721151769225,
"tamanhoArquivo": 312446,
"objectKey": "1721769225_661e1_251.pdf",
"tamanhoArquivoStorage": 312446,
"numeroSequencial": 1
},
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 22000,
"postoAtendimento": 55441,
"numeroSequencial": 364,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 2
},
"nome": "PROCURAÇÃO FXXXX PXXXXON - Copia.pdf",
"dataInclusao": 1721151818284,
"tamanhoArquivo": 1708876,
"objectKey": "172XX1818284_da873_30e.pdf",
"tamanhoArquivoStorage": 1708876,
"numeroSequencial": 2
}
]
},
"numeroFornecedorAtendimento": 1
}
],
"fornecedoresDetails": null
},
"responseAttrs": {}
}
```
**Respostas possíveis**
| Código HTTP | Descrição |
|---|
| `401` | Não autorizado (token inválido/expirado) |
| `403` | Acesso negado |
| `404` | Protocolo não encontrada |
| `500` | Erro interno no servidor |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `24070726001000503` |
| `dataAbertura` | string | ✅ Sim | Data de abertura no formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss | 2024-07-08 ou 2024-07-08T10:00:00 |
**Headers Obrigatórios**
TERMO DE NOTIFICAÇÃO - CARTA ELETRÔNICA
Número de Atendimento: 2406031700100176301
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum., além das possíveis sanções administrativas previstas no Código Defesa do Consumidor e legislações correlatas.
10 de Julho de 2024
",
"dataAvisoRecebimento": null,
"indicadorRespostaFornecedor": true,
"indicadorPrazoProrrogado": false,
"dataPrazoRespostaFornecedor": "2024-07-20",
"indicadorParticipacaoEletronica": true,
"indicadorParticipacaoCancelada": false,
"indicadorAtendimentoEletronico": true,
"respostaFornecedor": {
"data": 1721151781641,
"texto": "",
"anexos": [
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 10000210,
"postoAtendimento": 25451,
"numeroSequencial": 176,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 1
},
"nome": "DEFESA ADMINISTRATIVA PEDRO.pdf",
"dataInclusao": 1721151769225,
"tamanhoArquivo": 312446,
"objectKey": "1721769225_661e1_251.pdf",
"tamanhoArquivoStorage": 312446,
"numeroSequencial": 1
},
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 22000,
"postoAtendimento": 55441,
"numeroSequencial": 364,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 2
},
"nome": "PROCURAÇÃO FXXXX PXXXXON - Copia.pdf",
"dataInclusao": 1721151818284,
"tamanhoArquivo": 1708876,
"objectKey": "172XX1818284_da873_30e.pdf",
"tamanhoArquivoStorage": 1708876,
"numeroSequencial": 2
}
]
},
"numeroFornecedorAtendimento": 1
}
],
"fornecedoresDetails": null
},
"responseAttrs": {}
}
```
#### **Anexar arquivo na resposta do fornecedor**
**POST `/resposta-fornecedor`**
**Payload da requisição**
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| indicadorHouveRespostaFornecedor | Boolean | sim | Indica se houve resposta | true/false |
| codigoFornecedor | int | sim | Código do fornecedor | 123123 |
| nomeFornecedor | string | sim | Nome do fornecedor | Aaaa Bbbb |
| indicadorAtendimentoEletronico | Boolean | sim | Indica o se foi atendimento eletrônico | true/false |
| numeroFornecedorAtendimento | int | sim | Número do fornecedor atendido | 321321 |
| dataRespostaFornecedor | string | sim | Data da resposta | dd/mm/yyyy |
| textoRespostaFornecedor | string | sim | Descrição da resposta |
|
| anexos | List | sim | Arquivos para upload | 123Exemplo.pdf |
| ano | int | sim | Ano em que foi feito o protocolo | 2025 |
| mes | int | sim | Mês em que foi feito o protocolo | 07 |
| codigoCredenciada | int | sim | Código da credenciada | 54321 |
| codigoPosto | int | sim | Código do posto | 53412 |
| numeroSequencial | int | sim | Número sequencial do protocolo | 123454321 |
| dataAbertura | Long | sim | Data da abertura do protocolo | dd/mm/yyyy |
| indicadorTratativaMaisRecente | Boolean | sim | Indica se houve tratativa mais recente | true/false |
| Código | Descrição |
|---|
| 200 | Sucesso na troca do fornecedor |
| 401 | Não autorizado (token inválido) |
| 403 | Acesso negado |
| 500 | Erro interno do servidor |
| Parâmetro | Descrição | Exemplo |
|---|
| `numero` | Número do atendimento ou acompanhamento | XXXXXXXXXXXXXX |
| Código | Descrição |
|---|
| 404 | Atendimento não encontrado |
| 401 | Não autorizado (token inválido) |
| 500 | Erro interno no servidor |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `2XXXXXXXXXXXXXXXXX503` |
but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
Pelo exposto, recorre a este PROCON.
",
"numeroAcompanhamento": "2XXXXXXXXXXXXX3",
"dataAbertura": 1719508292080,
"horaEntrada": null,
"tipoAcompanhamento": {
"codigo": 3,
"nome": "Reclamação",
"descricao": "Reclamação"
},
"tipoOrigemAcompanhamento": {
"codigo": 1,
"nome": "Presencial",
"descricao": "Presencial"
},
"tipoConsulta": null,
"andamentos": [
{
"chavePrimaria": {
"numeroAndamentoAcompanhamento": 3XXXX2,
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 120540,
"postoAtendimento": 111431,
"numeroSequencial": X60,
"numeroAcompanhamento": "2XXXXXXXXXXXXXX3"
}
},
"andamento": {
"codigo": 392,
"nome": "Prazo Expirado para a Fase Decisão",
"codigoInterno": 60,
"indicadorAndamentoManual": false,
"chavePrimaria": 3012
},
"usuario": {
"codigo": 0,
"nome": "Usuário Sistema"
},
"andamentosAtendimento": [
{
"numeroAtendimentoFormatado": "2XX.XX6.03XX.00XXXX1.00XX6-3,
"numeroFornecedorAtendimento": 1,
"codigoFornecedor": 818,
"nomeFornecedor": "XXXa FXXXceira"
}
],
"data": 1751105447453,
"acompanhamento": {
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 210454,
"postoAtendimento": 102121,
"numeroSequencial": 541
},
"indicadorAtendimentoPreferencial": true,
"tipoAcompanhamento": {
"codigo": 3,
"nome": "Reclamação",
"descricao": "Reclamação"
},
"tipoOrigemAcompanhamento": {
"codigo": 1,
"nome": "Presencial",
"descricao": "Presencial"
},
"tipoFaseAcompanhamento": {
"codigo": 4,
"nome": "Finalizada",
"descricao": "Finalizada"
},
"numeroAcompanhamento": 24XXXXXXXXX3,
"textoAcompanhamento": " but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
Pelo exposto, recorre a este PROCON.
",
"dataInclusao": 1719508292080,
"dataInclusaoDecisao": null,
"dataLiberacaoAtendimento": null,
"usuarioAbertura": 1XXXX06,
"numeroAtendimentoFormatado": null,
"fornecedores": null,
"areaAtendimento": null,
"assuntoAtendimento": null,
"problemaAtendimento": null,
"comoComprou": null,
"textoReclamacao": " but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
",
"dataPrazoFinalizacao": 1750993200000,
"dataPrazoFaseTratativa": "2024-10-25",
"codigoCredenciada": 186030,
"codigoPostoAtendimento": 186031,
"numeroAcompanhamentoFormatado": "2XX.XX6.03XX.00XXXX1.00XX6-3",
"numeroAcompanhamentoString": "24XXXXXXXXX3",
"abertaOuTratativa": false,
"tratativa": false,
"denuncia": false,
"reclamacao": true,
"numeroAtendimentoAcompanhamentoFormatado": "2XX.XX6.03XX.00XXXX1.00XX6-3",
"consulta": false
}
},
],
"atendimentos": [
{
"chavePrimaria": {
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 186030,
"postoAtendimento": 186031,
"numeroSequencial": 176,
"numeroAcompanhamento": "24060317001001763"
},
"numeroFornecedorAtendimento": 1
},
"fornecedor": {
"codigo": 001,
"tipoCadastro": {
"codigoTipoCadastro": 3,
"nomeTipoCadastro": "Fornecedor"
},
"tipoEstadoCadastro": {
"codigoEstadoCadastro": 1,
"nomeEstadoCadastro": "Ativo"
},
"nomeCadastro": "FXXXX FiXXXXra S.A. Credito, FinaXXXXmento e InvXXXXmento",
"complementoEndereco": "1XX9 - salas 7XXX1 e 7XX02",
"cep": {
"operacao": null,
"nrCep": 9XXXX11,
"uf": "RS",
"localidade": {
"operacao": null,
"numeroLocalidade": XXX,
"uf": "RS",
"nomeLocalidade": "PXXo AlXXXe",
"cep": null,
"situacaoCodificacaoLogradouro": 1,
"tipoLocalidade": "M",
"numeroLocalidadeSubordinacao": null,
"abreviacaoNomeLocalidade": "Pto Alegre",
"codigoIBGEMunicipio": "431XXXX4902",
"chavePrimaria": XXX,
"operacaoRemocao": false,
"operacaoInclusao": false,
"operacaoAlteracao": false,
"operacaoInclusaoOuAlteracao": false
},
"codigoLocalidade": XXX,
"bairro": {
"operacao": null,
"codigo": 1XXX75,
"uf": "RS",
"localidade": 7XX4,
"nomeBairro": "Centro Histórico",
"nomeBairroAbreviado": "C Histórico",
"chavePrimaria": 1XXX5,
"operacaoRemocao": false,
"operacaoInclusao": false,
"operacaoAlteracao": false,
"operacaoInclusaoOuAlteracao": false
},
"codigoBairro": XX,
"logradouro": "RXX dos AndXXXXXas",
"complementoLogradouro": "- de 1XX1 a 15XXX7 - lado ímpar",
"nome": null,
"indicadorCepAtivo": true,
"nrCepAnteior": null,
"chavePrimaria": 9XXXXXXX,
"cep": "90020011",
"operacaoRemocao": false,
"operacaoInclusao": false,
"operacaoAlteracao": false,
"operacaoInclusaoOuAlteracao": false
},
"listaAnexo": [
{
"chavePrimaria": {
"codigo": 1,
"cadastro": 818
},
"nome": "FXXX FiXXXXra.pdf",
"dataInclusao": 1687459098138,
"operacao": null,
"usuario": {
"codigo": 1XX51,
"nome": "IXXXXXa AXXes CXXXrgo"
},
"tamanhoArquivo": 177365,
"indicadorAnexoPublico": null,
"objectKey": "1687459098138_d4e02_433.pdf",
"tamanhoArquivoStorage": 177365
}
],
"listaEmail": [
{
"chavePrimaria": {
"codigo": 7,
"cadastro": 818
},
"texto": "adm.contestacao@ercobranca.com.br",
"tipoEmail": {
"codigoTipoEmail": 4,
"nomeTipoEmail": "Alerta de Notificação"
},
"emailAlertaNotificacao": true,
"emailPrincipal": false,
"emailInstitucional": false
},
{
"chavePrimaria": {
"codigo": 8,
"cadastro": 818
},
"texto": "everton.medeiros@ercobranca.com.br",
"tipoEmail": {
"codigoTipoEmail": 3,
"nomeTipoEmail": "Ponto Focal"
},
"emailAlertaNotificacao": false,
"emailPrincipal": false,
"emailInstitucional": false
},
{
"chavePrimaria": {
"codigo": 10,
"cadastro": 818
},
"texto": "adm.contestacao@ercobranca.com.br",
"tipoEmail": {
"codigoTipoEmail": 2,
"nomeTipoEmail": "Institucional"
},
"emailAlertaNotificacao": false,
"emailPrincipal": false,
"emailInstitucional": true
}
],
"listaTelefone": [
{
"chavePrimaria": {
"codigo": 3,
"cadastro": 818
},
"codigoArea": "51",
"telefone": "30217838",
"tipoTelefone": {
"codigoTipoTelefone": 6,
"nomeTipoTelefone": "Institucional"
},
"telefonePrincipal": false,
"telefoneInstitucional": true
},
{
"chavePrimaria": {
"codigo": 4,
"cadastro": 818
},
"codigoArea": "61",
"telefone": "998552188",
"tipoTelefone": {
"codigoTipoTelefone": 2,
"nomeTipoTelefone": "Celular"
},
"telefonePrincipal": false,
"telefoneInstitucional": false
}
],
"nomeLogradouro": "Rua dos Andradas",
"nomeBairro": "Centro Histórico",
"tipoPessoa": {
"codigoTipoPessoa": 2,
"nomeTipoPessoa": "Jurídica"
},
"urlSite": "www.factafinanceira.com.br",
"dataCriacao": 1572017818000,
"indicadorAtendimentoEletronico": true,
"indicadorSuspensaoAtendimentoEletronico": false,
"indicadorPresencaConsumidorGov": true,
"credenciada": 1,
"listaCategoriaFornecedor": [
{
"chavePrimaria": {
"cadastroFornecedor": 818,
"categoria": {
"chavePrimaria": {
"codigo": 576,
"tipoCategoria": {
"codigo": 5,
"nome": "Segmento"
}
},
"nome": "Bancos, Financeiras e Administradoras de Cartão",
"ativo": true
}
}
}
],
"dataLimiteAlteracaoAuditor": 1572017818000,
"dataLimiteAlteracaoTecnicoCredenciada": 1572017818000,
"existeEnderecoCorrespondenciaCriadoPelaSenacon": false,
"dataEliminacao": null,
"dataDesativacao": null,
"indicadorSeloSenacon": true,
"dataHabilitacaoEletronica": 1649272623027,
"dataDesabilitacaoEletronica": null,
"dataSuspensaoEletronica": null,
"inclusao": false,
"cnpj": 15581638000130,
"nomeFantasia": "Facta Financeira",
"cnaePrincipal": {
"codigo": 6436100,
"descricao": "SOCIEDADES DE CREDITO, FINANCIAMENTO E INVESTIMENTO - FINANCEIRAS",
"chavePrimaria": 6436100,
"codigoFormatado": "6436-1/00"
},
"indicadorEmailAlertaNotificacao": null,
"fornecedorPrincipal": null,
"cpf": null,
"nomeFantasiaOuRazaoSocial": "Facta Financeira",
"chavePrimaria": 818,
"ativo": true
},
"fornecedores": [],
"indicadorFornecedorProcurado": true,
"tipoEstadoAtendimento": {
"codigo": 30,
"nome": "Prazo Expirado",
"codigoFase": 4,
"tratativa": false,
"descricao": "Prazo Expirado"
},
"textoContatoFornecedor": null,
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 254154,
"postoAtendimento": 185531,
"numeroSequencial": 356,
"numeroAcompanhamento": "2XXX545XXX01"
},
"existeTrativaFinalizada": true,
"numeroAtendimentoFormatado": "XX.0X.0XXXX.0XX1.0XXX6-3XX",
"numeroFornecedorAtendimento": 1,
"numeroAtendimento": 2XXX545XXX01
}
],
"anexos": [
{
"chavePrimaria": {
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 25454,
"postoAtendimento": 12545,
"numeroSequencial": 155,
"numeroAcompanhamento": "54545445545"
},
"numeroAnexoAcompanhamento": 2
},
"usuario": {
"codigo": 108006,
"nome": "GXXXXa NaXXXia TXXXio"
},
"indicadorAnexoPublico": false,
"nome": "1868 - CXXXE DO PORTO, SC.pdf",
"tamanhoArquivo": 1270990,
"dataInclusao": 1720639099160,
"objectKey": "1720639099160_be486_3ed.pdf",
"tamanhoArquivoStorage": 1270990
},
{
"chavePrimaria": {
"acompanhamento": {
"ano": 24,
"mes": 6,
"credenciada": 23641,
"postoAtendimento": 10140,
"numeroSequencial": 216,
"numeroAcompanhamento": "2XXXXXX1001XXX"
},
"numeroAnexoAcompanhamento": 1
},
"usuario": {
"codigo": 108006,
"nome": "GXXXXca NXXXXia TXXvXXo"
},
"indicadorAnexoPublico": false,
"nome": "Documentos Escaneados (2).pdf",
"tamanhoArquivo": 333430,
"dataInclusao": 1719508692184,
"objectKey": "1719508692184_4123a_11b.pdf",
"tamanhoArquivoStorage": 333430
}
],
"anotacoes": [],
"categorias": [
{
"codigo": 39,
"codigoTipo": 6,
"nomeTipo": null,
"nome": "Não comprei / contratrei",
"texto": null,
"tipoRevisao": null
},
{
"codigo": 571,
"codigoTipo": 1,
"nomeTipo": null,
"nome": "Serviços Financeiros",
"texto": null,
"tipoRevisao": null
},
{
"codigo": 817,
"codigoTipo": 2,
"nomeTipo": null,
"nome": "Crédito Consignado / Cartão de Crédito Consignado / RMC (para beneficiários do INSS)",
"texto": null,
"tipoRevisao": null
},
{
"codigo": 847,
"codigoTipo": 4,
"nomeTipo": null,
"nome": "Cartão não solicitado - Envio ou cobrança",
"texto": null,
"tipoRevisao": null
}
],
"vinculoReclamacaoOficio": [],
"consumidor": {
"codigo": 125452,
"nome": null,
"nomeSocial": null,
"sexo": null,
"telefone": null,
"email": null,
"tipoPessoa": {
"codigoTipoPessoa": 1,
"nomeTipoPessoa": "Física",
"descricao": "Física"
},
"tipoConsumidorPessoaFisica": {
"codigoTipoConsumidorPessoaFisica": 2,
"nomeTipoConsumidorPessoaFisica": "Nacional",
"codigo": 2,
"descricao": "Nacional"
},
"procurador": false,
"anonimo": false,
"consumidorSemCpf": false,
"cpfCnpj": null,
"endereco": null
},
"procurador": null,
"nomeFornecedores": null,
"nomeFantasiaFornecedor": null,
"arquivoCalculo": null,
"indicadorCalculoSolicitado": null,
"codigoUsuarioAbertura": 21501,
"nomeUsuarioAbertura": "GXXXX NaXXa TrXXXXo",
"indicadorProximoFila": null,
"indicadorBloqueio": null,
"indicadorDisponivelParaDistribuicao": false,
"textoReclamacao": " but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum
",
"existeAoMenosUmaTratativaFinalizada": true,
"indicadorExistenciaTratativa": true,
"protocoloConsumidorGov": null,
"setorDistribuicao": "",
"dataInclusaoDecisao": null,
"categoriaArea": null,
"categoriaAssunto": null,
"categoriaProblema": null
},
"responseAttrs": {}
}
```
---
**Respostas esperadas:**
| Código | Descrição |
|---|
| 400 | Erro de parâmetros |
| 401 | Não autorizado |
| 500 | Erro interno |
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `dry` | Não | Boolean | `false` | Execução de teste, alguns robôs não suportam este modo. |
| `bot` | **Sim** | String | — | ID do robô, consulte a documentação específica. |
| `version` | **Sim** | String | — | Versão do robô, atualmente este valor é `3.0.0-dev`. |
| `cid` | Não | String | — | Idempotência: se repetido, resposta será como item duplicado, `Duplicate`. |
| `force` | Não | Boolean | — | Força reexecução de um `cid` único. |
| `timeout` | Não | **Duration** | `5m` | Ex.: `30s`. |
| `deadline` | Não | **ZonedDateTime** | — | ISO-8601 com timezone. |
| `credentials` | Depende do robô | JSON | — | Credenciais necessárias para aquele robô. Atualmente os robôs operam apenas com credenciais salvas no cofre. |
| `data` | **Sim** | JSON | — | Payload específico do robô, consulte a documentação de cada robô. |
| `files` | Depende do robô | JSON\[\] | — | Anexos; cada item: `{ bound, property, description, name, data }` onde **`data`** é geralmente **Base64** do arquivo, mas consulte a documentação do robô para mais detalhes. |
## Descrição campos 'DATA'
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `integracao` | Não | String | — | Um identificado externo se for necessário enviar. |
| `cpf` | **Sim** | String | — | CPF do solicitante da contestaçãoI. |
| `data` | **Sim** | String | — | Data aplicação para pesquisar o solicitante. |
| `tipoArquivo` | **Sim** | String | — | Tipo de arquivo para identificação do anexo ex: Ficha, Autorização, Documento. |
| `arquivo` | **Sim** | base64 | — | Arquivo a ser anexado para envio. |
## Resultado da execução
Quando o resultado estiver pronto (**200**), a API retorna um objeto com metadados e o payload de saída:
```json
{
"account": 0,
"user": 0,
"bot": "bot-id",
"version": "x.y.z",
"cid": "opcional",
"request": "abc123",
"started": "2025-09-05T12:14:10-03:00",
"ended": "2025-09-05T12:14:45-03:00",
"taskTime": "35s",
"timeout": "30s",
"finishedAs": "Response",
"retry": "Allowed",
"dry": false,
"result": { /* payload específico do robô */ }
}
```
### `finishedAs` (principais valores)
- **Sucesso**: `Response`, `PartialResponse`
- **Falha de negócio**: `NotAllowed`, `NotFound`, `NotConsistent`, `NotAvailable`, `Forbidden`, `BotError`, `Other`
- **Falha de ambiente/contrato/dados**: `RequestHasViolations`, `NotAndApiRequest`, `NotAccepted`, `Timeout`, `Overdue`, `Duplicate`, `UnexpectedError`, `Unknown`
- **Outras falhas técnicas**: `ProxyError`, `CaptchaError`
> **Dica**: trate **HTTP 200** com `finishedAs != Response` como “erro de negócio/ambiente”, não como sucesso.
---
## Idempotência e reexecução
- **`cid`**: identifique execuções equivalentes; se um `cid` **não for único**, o item pode retornar **`Duplicate`** sem rodar de novo.
- **`force`**: reexecuta mesmo com `cid` único. Use com cautela.
- Estratégia comum: `cid = hash` de campos críticos dentro de `data` (quando fizer sentido).
---
## Boas práticas de polling
- **Mínimo até existir resposta**: a execução de um robô pode garantir um **delay mínimo** (ex.: ≥ 5s). Ajuste o primeiro poll para logo após esse limite.
- **Intervalo**: 5–10s é razoável; 7s é um bom equilíbrio para a maioria dos casos.
- **Tempo máximo/Orçamento**: defina um tempo máximo total (ex.: 2–8 min). Se exceder, encerre e reporte “pendente/timeout local”.
- **Códigos**:
- **404** → continue esperando.
- **200** → processe o resultado.
- **401/403** → pare e corrija credenciais/permissões.
- **429** → aplique **backoff** antes de tentar de novo.
---
## Tratamento de erros
- **401/403**: token inválido/sem permissão → revise `X-Oystr-Auth` / escopos.
- **404** no endpoint de resultado: item ainda processando → continue o polling.
- **429**: limite de taxa → aumente o intervalo (backoff) e tente de novo.
- **4xx no POST**: violações de contrato (payload/versão/bot inválidos) → corrija antes de retry.
- **200 com `finishedAs` não-sucesso**: trate conforme regra de negócio; alguns permitem reexecução (`ProxyError`, `CaptchaError`).
---
## Segurança e recomendações
- **Proteja o token** (`X-Oystr-Auth`): use variáveis de ambiente/cofres; evite logs com token.
- **TLS obrigatório** (`https`).
- **User-Agent identificável** ajuda na observabilidade do lado do servidor.
- **Arquivos** em `files[].data`: envie conteúdo **Base64** do binário. Valide tamanhos/formatos aceitos conforme o robô.
# API - exyon-bmg-info
## Visão geral
- **Base URL**: `https://api.oystr.com.br/v1`
- **Padrão**: chamadas **assíncronas**. Você recebe um **ID** na resposta imediata e consulta o resultado em um **endpoint de leitura** até estar pronto.
- **Formato**: JSON (requests e responses).
## Autenticação
- **Header**: `X-Oystr-Auth: `
- **Como obter**: Console Oystr → **Configurações** → **API** → **Criar chave de integração**.
- Envie este header **em todas as requisições**.
## Fluxos principais
### A) Validação de credenciais (assíncrona)
Esta etapa é importante quando o robô exigir **`credentials`** para acessar o sistema em que ele opera (usuário/senha/certificado etc.).
1\) **Ação (POST)**
`/credentials/validate/exyon-bmg-info/v1.0`
**Body (JSON)**:
```json
{
"hash": "hash da credencial no cofre"
}
```
**Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/cached/{id}`
\- **404**: ainda processando
\- **200**:
```json
{
"valid": true,
"notAllowed": null,
"notAvailable": null,
"message": null
}
```
> Interprete **`valid`** como o indicador principal de sucesso na validação. Caso o robô retone **`false`**, isso indica que ele não teve sucesso ao logar e a provável causa estará no campo **`message`**.
>
> **IMPORTANTE**: apesar de opcional, essa etapa pode ser incorporada na sua lógica para garantir que as credenciais são validas. Se o sistema que o robô irá operar tem baixa tolerância com autenticação, recomendamos que este teste seja feito com uma frequência maior. Caso contrário, esta validação pode ser feita de tempos em tempos, afim de garantir a operação.
### B) Execução do robô (assíncrona)
1\) **Ação (POST)**
`/execute/single`
**Body (JSON)** — ver campos na seção abaixo:
```json
{
"dry": false,
"bot": "exyon-bmg-info",
"version": "v3.0.0-dev",
"credentials": {
"username": "XPTO",
"password": "YPTO"
},
"data":
{
"processo":"CIV1583618"
}
}
```
#### **Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/execute/single/{botId}/{request_id}?format=latest`
\- **404**: ainda processando
\- **200**: retorna o **resultado final** (ver seção “Resultado da execução”).
> **Observação importante:**
> \- Para **validação** de credenciais, consulte em **`/cached/{id}`**.
> \- Para **execução** de item, consulte em **`/execute/single/{bot}/{id}?format=latest`**.
## Resultado da execução
Quando o resultado estiver pronto (**200**), a API retorna um objeto com metadados e o payload de saída:
```json
{
"bot": "exyon-bmg-info",
"version": "v3.0.0-dev",
"request": "20260309101539XXXXXXUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR",
"account": 1,
"user": 0021,
"cid": null,
"started": "2026-03-09T10:15:46.271-03:00[America/Sao_Paulo]",
"ended": "2026-03-09T10:16:06.58-03:00[America/Sao_Paulo]",
"taskTime": "20309ms",
"timeout": "300000ms",
"retry": "UNKNOWN",
"dry": false,
"finishedAs": "Response",
"result": {
"status": "Coleta baixada com sucesso",
"numeroProcesso": "52XXXX72025XXXXX21",
"dataInicio": "14/08/2025",
"pais": "BRASIL",
"municipio": "PASSO FUNDO",
"numeral": "04",
"instancia": "PRIMEIRA",
"area": "SUBSÍDIOS BMG EM CONTA",
"acao": "AÇÃO INDENIZATÓRIA",
"juizo": null,
"uf": "RIO GRANDE DO SUL",
"orgaoTribunal": "TRIBUNAL DE JUSTIÇA - RIO GRANDE DO SUL",
"denominacaoVara": "VARA CÍVEL",
"esfera": "JUSTIÇA ESTADUAL",
"assunto": "BMG EM CONTA",
"rito": "RITO ORDINÁRIO",
"escrevente": "",
"codigoPoloAtivo": "XXX75XXX3",
"nomePoloAtivo": "SXXXXX AXXXXXXXO NXXXXS",
"qualificacaoPoloAtivo": "PARTE AUTORA",
"codigoPoloPassivo": "XX60325XXX",
"nomePoloPassivo": "BANCO BMG",
"qualificacaoPoloPassivo": "PARTE RÉ",
"valorInicial": "8.150,28"
}
}
```
### `finishedAs` (principais valores)
- **Sucesso**: `Response`, `PartialResponse`
- **Falha de negócio**: `NotAllowed`, `NotFound`, `NotConsistent`, `NotAvailable`, `Forbidden`, `BotError`, `Other`
- **Falha de ambiente/contrato/dados**: `RequestHasViolations`, `NotAndApiRequest`, `NotAccepted`, `Timeout`, `Overdue`, `Duplicate`, `UnexpectedError`, `Unknown`
- **Outras falhas técnicas**: `ProxyError`, `CaptchaError`
> **Dica**: trate **HTTP 200** com `finishedAs != Response` como “erro de negócio/ambiente”, não como sucesso.
## Campos do payload de execução
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `dry` | Não | Boolean | `false` | Execução de teste, alguns robôs não suportam este modo. |
| `bot` | **Sim** | String | — | ID do robô, consulte a documentação específica. |
| `version` | **Sim** | String | — | Versão do robô, atualmente este valor é `3.0.0-dev`. |
| `cid` | Não | String | — | Idempotência: se repetido, resposta será como item duplicado, `Duplicate`. |
| `force` | Não | Boolean | — | Força reexecução de um `cid` único. |
| `timeout` | Não | **Duration** | `5m` | Ex.: `30s`. |
| `deadline` | Não | **ZonedDateTime** | — | ISO-8601 com timezone. |
| `credentials` | Depende do robô | JSON | — | Credenciais necessárias para aquele robô. Atualmente os robôs operam apenas com credenciais salvas no cofre. |
| `data` | **Sim** | JSON | — | Payload específico do robô, consulte a documentação de cada robô. |
| `files` | Depende do robô | JSON\[\] | — | Anexos; cada item: `{ bound, property, description, name, data }` onde **`data`** é geralmente **Base64** do arquivo, mas consulte a documentação do robô para mais detalhes. |
## Descrição campos 'DATA'
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `processo` | **Sim** | String | — | O número do processo o qual será coletado os dados. |
## Idempotência e reexecução
- **`cid`**: identifique execuções equivalentes; se um `cid` **não for único**, o item pode retornar **`Duplicate`** sem rodar de novo.
- **`force`**: reexecuta mesmo com `cid` único. Use com cautela.
- Estratégia comum: `cid = hash` de campos críticos dentro de `data` (quando fizer sentido).
---
## Boas práticas de polling
- **Mínimo até existir resposta**: a execução de um robô pode garantir um **delay mínimo** (ex.: ≥ 5s). Ajuste o primeiro poll para logo após esse limite.
- **Intervalo**: 5–10s é razoável; 7s é um bom equilíbrio para a maioria dos casos.
- **Tempo máximo/Orçamento**: defina um tempo máximo total (ex.: 2–8 min). Se exceder, encerre e reporte “pendente/timeout local”.
- **Códigos**:
- **404** → continue esperando.
- **200** → processe o resultado.
- **401/403** → pare e corrija credenciais/permissões.
- **429** → aplique **backoff** antes de tentar de novo.
---
## Tratamento de erros
- **401/403**: token inválido/sem permissão → revise `X-Oystr-Auth` / escopos.
- **404** no endpoint de resultado: item ainda processando → continue o polling.
- **429**: limite de taxa → aumente o intervalo (backoff) e tente de novo.
- **4xx no POST**: violações de contrato (payload/versão/bot inválidos) → corrija antes de retry.
- **200 com `finishedAs` não-sucesso**: trate conforme regra de negócio; alguns permitem reexecução (`ProxyError`, `CaptchaError`).
---
## Segurança e recomendações
- **Proteja o token** (`X-Oystr-Auth`): use variáveis de ambiente/cofres; evite logs com token.
- **TLS obrigatório** (`https`).
- **User-Agent identificável** ajuda na observabilidade do lado do servidor.
- **Arquivos** em `files[].data`: envie conteúdo **Base64** do binário. Valide tamanhos/formatos aceitos conforme o robô.
# API - projuris-digio-documentos-inserir
## Visão geral
- **Base URL**: `https://api.oystr.com.br/v1`
- **Padrão**: chamadas **assíncronas**. Você recebe um **ID** na resposta imediata e consulta o resultado em um **endpoint de leitura** até estar pronto.
- **Formato**: JSON (requests e responses).
## Autenticação
- **Header**: `X-Oystr-Auth: `
- **Como obter**: Console Oystr → **Configurações** → **API** → **Criar chave de integração**.
- Envie este header **em todas as requisições**.
## Fluxos principais
### A) Validação de credenciais (assíncrona)
Esta etapa é importante quando o robô exigir **`credentials`** para acessar o sistema em que ele opera (usuário/senha/certificado etc.).
1\) **Ação (POST)**
`/credentials/validate/projuris-digio-documentos-inserir/v1.0`
**Body (JSON)**:
```json
{
"hash": "hash da credencial no cofre"
}
```
**Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/cached/{id}`
\- **404**: ainda processando
\- **200**:
```json
{
"valid": true,
"notAllowed": null,
"notAvailable": null,
"message": null
}
```
> Interprete **`valid`** como o indicador principal de sucesso na validação. Caso o robô retone **`false`**, isso indica que ele não teve sucesso ao logar e a provável causa estará no campo **`message`**.
>
> **IMPORTANTE**: apesar de opcional, essa etapa pode ser incorporada na sua lógica para garantir que as credenciais são validas. Se o sistema que o robô irá operar tem baixa tolerância com autenticação, recomendamos que este teste seja feito com uma frequência maior. Caso contrário, esta validação pode ser feita de tempos em tempos, afim de garantir a operação.
### B) Execução do robô (assíncrona)
1\) **Ação (POST)**
`/execute/single`
**Body (JSON)** — ver campos na seção abaixo:
```json
{
"dry": false,
"bot": "projuris-digio-documentos-inserir",
"version": "v3.0.0-dev",
"credentials": {
"username": "XPTO",
"password": "YPTO"
},
"data":
{
"integracao":"",
"pasta":"CIV1583618",
"dataEvento":"CIV1583618",
"evento":"CIV1583618",
"fase":"CIV1583618",
"relevante":"CIV1583618",
"listarComoAndamento":"CIV1583618",
"arquivo": [
{
"arquivo": "teste.pdf",
"tipoArquivo": "teste"
}
]
},
"files": [{
"name": "teste.pdf",
"dataArquivo": "",
"tipoArquivo": "",
"error" : false,
"location" : null,
"description" : null,
"bound" : true,
"targetName" : null,
"property" : "arquivo",
"data":""
}
]
}
}
```
#### **Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/execute/single/{botId}/{request_id}?format=latest`
\- **404**: ainda processando
\- **200**: retorna o **resultado final** (ver seção “Resultado da execução”).
> **Observação importante:**
> \- Para **validação** de credenciais, consulte em **`/cached/{id}`**.
> \- Para **execução** de item, consulte em **`/execute/single/{bot}/{id}?format=latest`**.
## Resultado da execução
Quando o resultado estiver pronto (**200**), a API retorna um objeto com metadados e o payload de saída:
```json
{
"bot": "projuris-digio-documentos-inserir",
"version": "v3.0.0-dev",
"request": "20260309101539XXXXXXUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR",
"account": 1,
"user": 0021,
"cid": null,
"started": "2026-03-09T10:15:46.271-03:00[America/Sao_Paulo]",
"ended": "2026-03-09T10:16:06.58-03:00[America/Sao_Paulo]",
"taskTime": "20309ms",
"timeout": "300000ms",
"retry": "UNKNOWN",
"dry": false,
"finishedAs": "Response",
"result": {
"status": "Documento(s) inserido(s) com sucesso!",
}
}
```
### `finishedAs` (principais valores)
- **Sucesso**: `Response`, `PartialResponse`
- **Falha de negócio**: `NotAllowed`, `NotFound`, `NotConsistent`, `NotAvailable`, `Forbidden`, `BotError`, `Other`
- **Falha de ambiente/contrato/dados**: `RequestHasViolations`, `NotAndApiRequest`, `NotAccepted`, `Timeout`, `Overdue`, `Duplicate`, `UnexpectedError`, `Unknown`
- **Outras falhas técnicas**: `ProxyError`, `CaptchaError`
> **Dica**: trate **HTTP 200** com `finishedAs != Response` como “erro de negócio/ambiente”, não como sucesso.
## Campos do payload de execução
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `dry` | Não | Boolean | `false` | Execução de teste, alguns robôs não suportam este modo. |
| `bot` | **Sim** | String | — | ID do robô, consulte a documentação específica. |
| `version` | **Sim** | String | — | Versão do robô, atualmente este valor é `3.0.0-dev`. |
| `cid` | Não | String | — | Idempotência: se repetido, resposta será como item duplicado, `Duplicate`. |
| `force` | Não | Boolean | — | Força reexecução de um `cid` único. |
| `timeout` | Não | **Duration** | `5m` | Ex.: `30s`. |
| `deadline` | Não | **ZonedDateTime** | — | ISO-8601 com timezone. |
| `credentials` | Depende do robô | JSON | — | Credenciais necessárias para aquele robô. Atualmente os robôs operam apenas com credenciais salvas no cofre. |
| `data` | **Sim** | JSON | — | Payload específico do robô, consulte a documentação de cada robô. |
| `files` | Depende do robô | JSON\[\] | — | Anexos; cada item: `{ bound, property, description, name, data }` onde **`data`** é geralmente **Base64** do arquivo, mas consulte a documentação do robô para mais detalhes. |
## Descrição campos 'DATA'
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| processo | **Sim** | String | — | O número do processo o qual será coletado os dados. |
| integracao | **Não** | String | — | Código interno da empresa |
| pasta | **Sim** | String | — | Pasta do documento |
| dataEvento | **Não** | String | — | Data do andamento |
| evento | **Não** | String | — | Tipo do andamento |
| fase | **Não** | String | — | Fase do andamento |
| relevante | **Não** | String | — |
|
| listarComoAndamento | **Não** | String | — |
|
| arquivos | **Sim** | String | — | Documento a ser anexado |
## Idempotência e reexecução
- **`cid`**: identifique execuções equivalentes; se um `cid` **não for único**, o item pode retornar **`Duplicate`** sem rodar de novo.
- **`force`**: reexecuta mesmo com `cid` único. Use com cautela.
- Estratégia comum: `cid = hash` de campos críticos dentro de `data` (quando fizer sentido).
---
## Boas práticas de polling
- **Mínimo até existir resposta**: a execução de um robô pode garantir um **delay mínimo** (ex.: ≥ 5s). Ajuste o primeiro poll para logo após esse limite.
- **Intervalo**: 5–10s é razoável; 7s é um bom equilíbrio para a maioria dos casos.
- **Tempo máximo/Orçamento**: defina um tempo máximo total (ex.: 2–8 min). Se exceder, encerre e reporte “pendente/timeout local”.
- **Códigos**:
- **404** → continue esperando.
- **200** → processe o resultado.
- **401/403** → pare e corrija credenciais/permissões.
- **429** → aplique **backoff** antes de tentar de novo.
---
## Tratamento de erros
- **401/403**: token inválido/sem permissão → revise `X-Oystr-Auth` / escopos.
- **404** no endpoint de resultado: item ainda processando → continue o polling.
- **429**: limite de taxa → aumente o intervalo (backoff) e tente de novo.
- **4xx no POST**: violações de contrato (payload/versão/bot inválidos) → corrija antes de retry.
- **200 com `finishedAs` não-sucesso**: trate conforme regra de negócio; alguns permitem reexecução (`ProxyError`, `CaptchaError`).
---
## Segurança e recomendações
- **Proteja o token** (`X-Oystr-Auth`): use variáveis de ambiente/cofres; evite logs com token.
- **TLS obrigatório** (`https`).
- **User-Agent identificável** ajuda na observabilidade do lado do servidor.
- **Arquivos** em `files[].data`: envie conteúdo **Base64** do binário. Valide tamanhos/formatos aceitos conforme o robô.
# API - bradesco-lexweb-info
## Visão geral
- **Base URL**: `https://api.oystr.com.br/v1`
- **Padrão**: chamadas **assíncronas**. Você recebe um **ID** na resposta imediata e consulta o resultado em um **endpoint de leitura** até estar pronto.
- **Formato**: JSON (requests e responses).
## Autenticação
- **Header**: `X-Oystr-Auth: `
- **Como obter**: Console Oystr → **Configurações** → **API** → **Criar chave de integração**.
- Envie este header **em todas as requisições**.
## Fluxos principais
### A) Validação de credenciais (assíncrona)
Esta etapa é importante quando o robô exigir **`credentials`** para acessar o sistema em que ele opera (usuário/senha/certificado etc.).
1\) **Ação (POST)**
`/credentials/validate/exyon-bmg-info/v1.0`
**Body (JSON)**:
```json
{
"username":"XPTO",
"password":"YPTO"
}
```
**Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/cached/{id}`
\- **404**: ainda processando
\- **200**:
```json
{
"valid": true,
"notAllowed": null,
"notAvailable": null,
"message": null
}
```
> Interprete **`valid`** como o indicador principal de sucesso na validação. Caso o robô retone **`false`**, isso indica que ele não teve sucesso ao logar e a provável causa estará no campo **`message`**.
>
> **IMPORTANTE**: apesar de opcional, essa etapa pode ser incorporada na sua lógica para garantir que as credenciais são validas. Se o sistema que o robô irá operar tem baixa tolerância com autenticação, recomendamos que este teste seja feito com uma frequência maior. Caso contrário, esta validação pode ser feita de tempos em tempos, afim de garantir a operação.
### B) Execução do robô (assíncrona)
1\) **Ação (POST)**
`/execute/single`
**Body (JSON)** — ver campos na seção abaixo:
```json
{
"dry": false,
"bot": "bradesco-lexweb-info",
"version": "v3.0.0-dev",
"credentials": {
"username": "XPTO",
"password": "YPTO"
},
"data":
{
"numeroDossie":"2023/8XXXX-X"
}
}
```
#### **Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/execute/single/{botId}/{request_id}?format=latest`
\- **404**: ainda processando
\- **200**: retorna o **resultado final** (ver seção “Resultado da execução”).
> **Observação importante:**
> \- Para **validação** de credenciais, consulte em **`/cached/{id}`**.
> \- Para **execução** de item, consulte em **`/execute/single/{bot}/{id}?format=latest`**.
## Resultado da execução
Quando o resultado estiver pronto (**200**), a API retorna um objeto com metadados e o payload de saída:
```json
{
"bot": "exyon-bmg-info",
"version": "v3.0.0-dev",
"request": "20260309101539XXXXXXUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR",
"account": 1,
"user": 0021,
"cid": null,
"started": "2026-03-09T10:15:46.271-03:00[America/Sao_Paulo]",
"ended": "2026-03-09T10:16:06.58-03:00[America/Sao_Paulo]",
"taskTime": "20309ms",
"timeout": "300000ms",
"retry": "UNKNOWN",
"dry": false,
"finishedAs": "Response",
"result": {
"status": "Coleta baixada com sucesso",
"numeroProcesso": "52XXXX72025XXXXX21",
"dataInicio": "14/08/2025",
"pais": "BRASIL",
"municipio": "PASSO FUNDO",
"numeral": "04",
"instancia": "PRIMEIRA",
"area": "SUBSÍDIOS BMG EM CONTA",
"acao": "AÇÃO INDENIZATÓRIA",
"juizo": null,
"uf": "RIO GRANDE DO SUL",
"orgaoTribunal": "TRIBUNAL DE JUSTIÇA - RIO GRANDE DO SUL",
"denominacaoVara": "VARA CÍVEL",
"esfera": "JUSTIÇA ESTADUAL",
"assunto": "BMG EM CONTA",
"rito": "RITO ORDINÁRIO",
"escrevente": "",
"codigoPoloAtivo": "XXX75XXX3",
"nomePoloAtivo": "SXXXXX AXXXXXXXO NXXXXS",
"qualificacaoPoloAtivo": "PARTE AUTORA",
"codigoPoloPassivo": "XX60325XXX",
"nomePoloPassivo": "BANCO BMG",
"qualificacaoPoloPassivo": "PARTE RÉ",
"valorInicial": "8.150,28"
}
}
```
### `finishedAs` (principais valores)
- **Sucesso**: `Response`, `PartialResponse`
- **Falha de negócio**: `NotAllowed`, `NotFound`, `NotConsistent`, `NotAvailable`, `Forbidden`, `BotError`, `Other`
- **Falha de ambiente/contrato/dados**: `RequestHasViolations`, `NotAndApiRequest`, `NotAccepted`, `Timeout`, `Overdue`, `Duplicate`, `UnexpectedError`, `Unknown`
- **Outras falhas técnicas**: `ProxyError`, `CaptchaError`
> **Dica**: trate **HTTP 200** com `finishedAs != Response` como “erro de negócio/ambiente”, não como sucesso.
## Campos do payload de execução
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `dry` | Não | Boolean | `false` | Execução de teste, alguns robôs não suportam este modo. |
| `bot` | **Sim** | String | — | ID do robô, consulte a documentação específica. |
| `version` | **Sim** | String | — | Versão do robô, atualmente este valor é `3.0.0-dev`. |
| `cid` | Não | String | — | Idempotência: se repetido, resposta será como item duplicado, `Duplicate`. |
| `force` | Não | Boolean | — | Força reexecução de um `cid` único. |
| `timeout` | Não | **Duration** | `5m` | Ex.: `30s`. |
| `deadline` | Não | **ZonedDateTime** | — | ISO-8601 com timezone. |
| `credentials` | Depende do robô | JSON | — | Credenciais necessárias para aquele robô. Atualmente os robôs operam apenas com credenciais salvas no cofre. |
| `data` | **Sim** | JSON | — | Payload específico do robô, consulte a documentação de cada robô. |
| `files` | Depende do robô | JSON\[\] | — | Anexos; cada item: `{ bound, property, description, name, data }` onde **`data`** é geralmente **Base64** do arquivo, mas consulte a documentação do robô para mais detalhes. |
## Descrição campos 'DATA'
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `numeroDossie` | **Sim** | String | — | O número do processo o qual será coletado os dados. |
## Idempotência e reexecução
- **`cid`**: identifique execuções equivalentes; se um `cid` **não for único**, o item pode retornar **`Duplicate`** sem rodar de novo.
- **`force`**: reexecuta mesmo com `cid` único. Use com cautela.
- Estratégia comum: `cid = hash` de campos críticos dentro de `data` (quando fizer sentido).
---
## Boas práticas de polling
- **Mínimo até existir resposta**: a execução de um robô pode garantir um **delay mínimo** (ex.: ≥ 5s). Ajuste o primeiro poll para logo após esse limite.
- **Intervalo**: 5–10s é razoável; 7s é um bom equilíbrio para a maioria dos casos.
- **Tempo máximo/Orçamento**: defina um tempo máximo total (ex.: 2–8 min). Se exceder, encerre e reporte “pendente/timeout local”.
- **Códigos**:
- **404** → continue esperando.
- **200** → processe o resultado.
- **401/403** → pare e corrija credenciais/permissões.
- **429** → aplique **backoff** antes de tentar de novo.
---
## Tratamento de erros
- **401/403**: token inválido/sem permissão → revise `X-Oystr-Auth` / escopos.
- **404** no endpoint de resultado: item ainda processando → continue o polling.
- **429**: limite de taxa → aumente o intervalo (backoff) e tente de novo.
- **4xx no POST**: violações de contrato (payload/versão/bot inválidos) → corrija antes de retry.
- **200 com `finishedAs` não-sucesso**: trate conforme regra de negócio; alguns permitem reexecução (`ProxyError`, `CaptchaError`).
---
## Segurança e recomendações
- **Proteja o token** (`X-Oystr-Auth`): use variáveis de ambiente/cofres; evite logs com token.
- **TLS obrigatório** (`https`).
- **User-Agent identificável** ajuda na observabilidade do lado do servidor.
- **Arquivos** em `files[].data`: envie conteúdo **Base64** do binário. Valide tamanhos/formatos aceitos conforme o robô.
# API - exyon-bmg-justificativas-inserir
## Visão geral
- **Base URL**: `https://api.oystr.com.br/v1`
- **Padrão**: chamadas **assíncronas**. Você recebe um **ID** na resposta imediata e consulta o resultado em um **endpoint de leitura** até estar pronto.
- **Formato**: JSON (requests e responses).
## Autenticação
- **Header**: `X-Oystr-Auth: `
- **Como obter**: Console Oystr → **Configurações** → **API** → **Criar chave de integração**.
- Envie este header **em todas as requisições**.
## Fluxos principais
### A) Validação de credenciais (assíncrona)
Esta etapa é importante quando o robô exigir **`credentials`** para acessar o sistema em que ele opera (usuário/senha/certificado etc.).
1\) **Ação (POST)**
`/credentials/validate/exyon-bmg-justificativas-inserir/v1.0`
**Body (JSON)**:
```json
{
"username":"XPTO",
"password":"YPTO"
}
```
**Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/cached/{id}`
\- **404**: ainda processando
\- **200**:
```json
{
"valid": true,
"notAllowed": null,
"notAvailable": null,
"message": null
}
```
> Interprete **`valid`** como o indicador principal de sucesso na validação. Caso o robô retone **`false`**, isso indica que ele não teve sucesso ao logar e a provável causa estará no campo **`message`**.
>
> **IMPORTANTE**: apesar de opcional, essa etapa pode ser incorporada na sua lógica para garantir que as credenciais são validas. Se o sistema que o robô irá operar tem baixa tolerância com autenticação, recomendamos que este teste seja feito com uma frequência maior. Caso contrário, esta validação pode ser feita de tempos em tempos, afim de garantir a operação.
### B) Execução do robô (assíncrona)
1\) **Ação (POST)**
`/execute/single`
**Body (JSON)** — ver campos na seção abaixo:
```json
{
"dry": false,
"bot": "exyon-bmg-justificativas-inserir",
"version": "v3.0.0-dev",
"credentials": {
"username": "XPTO",
"password": "YPTO"
},
"data":
{
"processo":"0001955-66.XXXX.8.XX.XXXX"
}
}
```
#### **Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/execute/single/{botId}/{request_id}?format=latest`
\- **404**: ainda processando
\- **200**: retorna o **resultado final** (ver seção “Resultado da execução”).
> **Observação importante:**
> \- Para **validação** de credenciais, consulte em **`/cached/{id}`**.
> \- Para **execução** de item, consulte em **`/execute/single/{bot}/{id}?format=latest`**.
## Resultado da execução
Quando o resultado estiver pronto (**200**), a API retorna um objeto com metadados e o payload de saída:
```json
{
"bot": "exyon-bmg-justificativas-inserir",
"version": "v3.0.0-dev",
"request": "20260309101539XXXXXXUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR",
"account": 1,
"user": 0021,
"cid": null,
"started": "2026-03-09T10:15:46.271-03:00[America/Sao_Paulo]",
"ended": "2026-03-09T10:16:06.58-03:00[America/Sao_Paulo]",
"taskTime": "20309ms",
"timeout": "300000ms",
"retry": "UNKNOWN",
"dry": false,
"finishedAs": "Response",
"result": {
"status": "Andamento realizado com sucesso",
}
}
```
### `finishedAs` (principais valores)
- **Sucesso**: `Response`, `PartialResponse`
- **Falha de negócio**: `NotAllowed`, `NotFound`, `NotConsistent`, `NotAvailable`, `Forbidden`, `BotError`, `Other`
- **Falha de ambiente/contrato/dados**: `RequestHasViolations`, `NotAndApiRequest`, `NotAccepted`, `Timeout`, `Overdue`, `Duplicate`, `UnexpectedError`, `Unknown`
- **Outras falhas técnicas**: `ProxyError`, `CaptchaError`
> **Dica**: trate **HTTP 200** com `finishedAs != Response` como “erro de negócio/ambiente”, não como sucesso.
## Campos do payload de execução
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `dry` | Não | Boolean | `false` | Execução de teste, alguns robôs não suportam este modo. |
| `bot` | **Sim** | String | — | ID do robô, consulte a documentação específica. |
| `version` | **Sim** | String | — | Versão do robô, atualmente este valor é `3.0.0-dev`. |
| `cid` | Não | String | — | Idempotência: se repetido, resposta será como item duplicado, `Duplicate`. |
| `force` | Não | Boolean | — | Força reexecução de um `cid` único. |
| `timeout` | Não | **Duration** | `5m` | Ex.: `30s`. |
| `deadline` | Não | **ZonedDateTime** | — | ISO-8601 com timezone. |
| `credentials` | Depende do robô | JSON | — | Credenciais necessárias para aquele robô. Atualmente os robôs operam apenas com credenciais salvas no cofre. |
| `data` | **Sim** | JSON | — | Payload específico do robô, consulte a documentação de cada robô. |
| `files` | Depende do robô | JSON\[\] | — | Anexos; cada item: `{ bound, property, description, name, data }` onde **`data`** é geralmente **Base64** do arquivo, mas consulte a documentação do robô para mais detalhes. |
## Descrição campos 'DATA'
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `processo` | **Sim** | String | — | O número do processo o qual será coletado os dados. |
## Idempotência e reexecução
- **`cid`**: identifique execuções equivalentes; se um `cid` **não for único**, o item pode retornar **`Duplicate`** sem rodar de novo.
- **`force`**: reexecuta mesmo com `cid` único. Use com cautela.
- Estratégia comum: `cid = hash` de campos críticos dentro de `data` (quando fizer sentido).
---
## Boas práticas de polling
- **Mínimo até existir resposta**: a execução de um robô pode garantir um **delay mínimo** (ex.: ≥ 5s). Ajuste o primeiro poll para logo após esse limite.
- **Intervalo**: 5–10s é razoável; 7s é um bom equilíbrio para a maioria dos casos.
- **Tempo máximo/Orçamento**: defina um tempo máximo total (ex.: 2–8 min). Se exceder, encerre e reporte “pendente/timeout local”.
- **Códigos**:
- **404** → continue esperando.
- **200** → processe o resultado.
- **401/403** → pare e corrija credenciais/permissões.
- **429** → aplique **backoff** antes de tentar de novo.
---
## Tratamento de erros
- **401/403**: token inválido/sem permissão → revise `X-Oystr-Auth` / escopos.
- **404** no endpoint de resultado: item ainda processando → continue o polling.
- **429**: limite de taxa → aumente o intervalo (backoff) e tente de novo.
- **4xx no POST**: violações de contrato (payload/versão/bot inválidos) → corrija antes de retry.
- **200 com `finishedAs` não-sucesso**: trate conforme regra de negócio; alguns permitem reexecução (`ProxyError`, `CaptchaError`).
---
## Segurança e recomendações
- **Proteja o token** (`X-Oystr-Auth`): use variáveis de ambiente/cofres; evite logs com token.
- **TLS obrigatório** (`https`).
- **User-Agent identificável** ajuda na observabilidade do lado do servidor.
- **Arquivos** em `files[].data`: envie conteúdo **Base64** do binário. Valide tamanhos/formatos aceitos conforme o robô.
# API - exyon-bmg-andamentos-inserir
## Visão geral
- **Base URL**: `https://api.oystr.com.br/v1`
- **Padrão**: chamadas **assíncronas**. Você recebe um **ID** na resposta imediata e consulta o resultado em um **endpoint de leitura** até estar pronto.
- **Formato**: JSON (requests e responses).
## Autenticação
- **Header**: `X-Oystr-Auth: `
- **Como obter**: Console Oystr → **Configurações** → **API** → **Criar chave de integração**.
- Envie este header **em todas as requisições**.
## Fluxos principais
### A) Validação de credenciais (assíncrona)
Esta etapa é importante quando o robô exigir **`credentials`** para acessar o sistema em que ele opera (usuário/senha/certificado etc.).
1\) **Ação (POST)**
`/credentials/validate/exyon-bmg-andamentos-inserir/v1.0`
**Body (JSON)**:
```json
{
"username":"XPTO",
"password":"YPTO"
}
```
**Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/cached/{id}`
\- **404**: ainda processando
\- **200**:
```json
{
"valid": true,
"notAllowed": null,
"notAvailable": null,
"message": null
}
```
> Interprete **`valid`** como o indicador principal de sucesso na validação. Caso o robô retone **`false`**, isso indica que ele não teve sucesso ao logar e a provável causa estará no campo **`message`**.
>
> **IMPORTANTE**: apesar de opcional, essa etapa pode ser incorporada na sua lógica para garantir que as credenciais são validas. Se o sistema que o robô irá operar tem baixa tolerância com autenticação, recomendamos que este teste seja feito com uma frequência maior. Caso contrário, esta validação pode ser feita de tempos em tempos, afim de garantir a operação.
### B) Execução do robô (assíncrona)
1\) **Ação (POST)**
`/execute/single`
**Body (JSON)** — ver campos na seção abaixo:
```json
{
"dry": false,
"bot": "exyon-bmg-andamentos-inserir",
"version": "v3.0.0-dev",
"credentials": {
"username": "XPTO",
"password": "YPTO"
},
"data":
{
"andamento":"0001955-66.XXXX.8.XX.XXXX",
"descricao":"XPTO",
"integracao":"0001955-66.XXXX.8.XX.XXXX",
"processo":"CIVXXXXXX",
"responsavel":"",
"status":"",
"valorMoral":"",
"arquivos": [
{
"tipoDocumento": "FICHA",
"descricaoArquivo": "FICHA",
"arquivo": "teste.pdf"
}
]
"files": [{
"name": "teste.pdf",
"error" : false,
"location" : null,
"description" : null,
"bound" : true,
"targetName" : null,
"property" : "arquivo",
"data": "JVBERi0xLjcKCjQgMCBvYmoK"
}]
}
}
```
#### **Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/execute/single/{botId}/{request_id}?format=latest`
\- **404**: ainda processando
\- **200**: retorna o **resultado final** (ver seção “Resultado da execução”).
> **Observação importante:**
> \- Para **validação** de credenciais, consulte em **`/cached/{id}`**.
> \- Para **execução** de item, consulte em **`/execute/single/{bot}/{id}?format=latest`**.
## Resultado da execução
Quando o resultado estiver pronto (**200**), a API retorna um objeto com metadados e o payload de saída:
```json
{
"bot": "exyon-bmg-andamentos-inserir",
"version": "v3.0.0-dev",
"request": "20260309101539XXXXXXUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR",
"account": 1,
"user": 0021,
"cid": null,
"started": "2026-03-09T10:15:46.271-03:00[America/Sao_Paulo]",
"ended": "2026-03-09T10:16:06.58-03:00[America/Sao_Paulo]",
"taskTime": "20309ms",
"timeout": "300000ms",
"retry": "UNKNOWN",
"dry": false,
"finishedAs": "Response",
"result": {
"status": "Documento Vinculado com Sucesso"
}
}
```
### `finishedAs` (principais valores)
- **Sucesso**: `Response`, `PartialResponse`
- **Falha de negócio**: `NotAllowed`, `NotFound`, `NotConsistent`, `NotAvailable`, `Forbidden`, `BotError`, `Other`
- **Falha de ambiente/contrato/dados**: `RequestHasViolations`, `NotAndApiRequest`, `NotAccepted`, `Timeout`, `Overdue`, `Duplicate`, `UnexpectedError`, `Unknown`
- **Outras falhas técnicas**: `ProxyError`, `CaptchaError`
> **Dica**: trate **HTTP 200** com `finishedAs != Response` como “erro de negócio/ambiente”, não como sucesso.
## Campos do payload de execução
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `dry` | Não | Boolean | `false` | Execução de teste, alguns robôs não suportam este modo. |
| `bot` | **Sim** | String | — | ID do robô, consulte a documentação específica. |
| `version` | **Sim** | String | — | Versão do robô, atualmente este valor é `3.0.0-dev`. |
| `cid` | Não | String | — | Idempotência: se repetido, resposta será como item duplicado, `Duplicate`. |
| `force` | Não | Boolean | — | Força reexecução de um `cid` único. |
| `timeout` | Não | **Duration** | `5m` | Ex.: `30s`. |
| `deadline` | Não | **ZonedDateTime** | — | ISO-8601 com timezone. |
| `credentials` | Depende do robô | JSON | — | Credenciais necessárias para aquele robô. Atualmente os robôs operam apenas com credenciais salvas no cofre. |
| `data` | **Sim** | JSON | — | Payload específico do robô, consulte a documentação de cada robô. |
| `files` | Depende do robô | JSON\[\] | — | Anexos; cada item: `{ bound, property, description, name, data }` onde **`data`** é geralmente **Base64** do arquivo, mas consulte a documentação do robô para mais detalhes. |
## Descrição campos 'DATA'
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| processo | **Sim** | String | — | O número do processo o qual será coletado os dados. |
| integracao | **Não** | String | — | Código interno da empresa server com referência |
| status | **Não** | String | — | Status do andamento |
| andamento | **Não** | String | — | Tipo de andamento |
| responsavel | **Não** | String | — | Responsável pelo andamento |
| valorMoral | **Não** | String | — | Valor aplicado |
| descricao | **Não** | String | — | Informação que se juga importante |
|
|
|
|
|
|
## Idempotência e reexecução
- **`cid`**: identifique execuções equivalentes; se um `cid` **não for único**, o item pode retornar **`Duplicate`** sem rodar de novo.
- **`force`**: reexecuta mesmo com `cid` único. Use com cautela.
- Estratégia comum: `cid = hash` de campos críticos dentro de `data` (quando fizer sentido).
---
## Boas práticas de polling
- **Mínimo até existir resposta**: a execução de um robô pode garantir um **delay mínimo** (ex.: ≥ 5s). Ajuste o primeiro poll para logo após esse limite.
- **Intervalo**: 5–10s é razoável; 7s é um bom equilíbrio para a maioria dos casos.
- **Tempo máximo/Orçamento**: defina um tempo máximo total (ex.: 2–8 min). Se exceder, encerre e reporte “pendente/timeout local”.
- **Códigos**:
- **404** → continue esperando.
- **200** → processe o resultado.
- **401/403** → pare e corrija credenciais/permissões.
- **429** → aplique **backoff** antes de tentar de novo.
---
## Tratamento de erros
- **401/403**: token inválido/sem permissão → revise `X-Oystr-Auth` / escopos.
- **404** no endpoint de resultado: item ainda processando → continue o polling.
- **429**: limite de taxa → aumente o intervalo (backoff) e tente de novo.
- **4xx no POST**: violações de contrato (payload/versão/bot inválidos) → corrija antes de retry.
- **200 com `finishedAs` não-sucesso**: trate conforme regra de negócio; alguns permitem reexecução (`ProxyError`, `CaptchaError`).
---
## Segurança e recomendações
- **Proteja o token** (`X-Oystr-Auth`): use variáveis de ambiente/cofres; evite logs com token.
- **TLS obrigatório** (`https`).
- **User-Agent identificável** ajuda na observabilidade do lado do servidor.
- **Arquivos** em `files[].data`: envie conteúdo **Base64** do binário. Valide tamanhos/formatos aceitos conforme o robô.
# API - projuris-digio-requisicoes-inserir
## Visão geral
- **Base URL**: `https://api.oystr.com.br/v1`
- **Padrão**: chamadas **assíncronas**. Você recebe um **ID** na resposta imediata e consulta o resultado em um **endpoint de leitura** até estar pronto.
- **Formato**: JSON (requests e responses).
## Autenticação
- **Header**: `X-Oystr-Auth: `
- **Como obter**: Console Oystr → **Configurações** → **API** → **Criar chave de integração**.
- Envie este header **em todas as requisições**.
## Fluxos principais
### A) Validação de credenciais (assíncrona)
Esta etapa é importante quando o robô exigir **`credentials`** para acessar o sistema em que ele opera (usuário/senha/certificado etc.).
1\) **Ação (POST)**
`/credentials/validate/projuris-digio-requisicoes-inserir/v1.0`
**Body (JSON)**:
```json
{
"hash": "hash da credencial no cofre"
}
```
**Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/cached/{id}`
\- **404**: ainda processando
\- **200**:
```json
{
"valid": true,
"notAllowed": null,
"notAvailable": null,
"message": null
}
```
> Interprete **`valid`** como o indicador principal de sucesso na validação. Caso o robô retone **`false`**, isso indica que ele não teve sucesso ao logar e a provável causa estará no campo **`message`**.
>
> **IMPORTANTE**: apesar de opcional, essa etapa pode ser incorporada na sua lógica para garantir que as credenciais são validas. Se o sistema que o robô irá operar tem baixa tolerância com autenticação, recomendamos que este teste seja feito com uma frequência maior. Caso contrário, esta validação pode ser feita de tempos em tempos, afim de garantir a operação.
### B) Execução do robô (assíncrona)
1\) **Ação (POST)**
`/execute/single`
**Body (JSON)** — ver campos na seção abaixo:
```json
{
"dry": false,
"bot": "projuris-digio-requisicoes-inserir",
"version": "v3.0.0-dev",
"credentials": {
"username": "XPTO",
"password": "YPTO"
},
"data":
{
"integracao":"267205",
"pasta":"267205",
"processo":"4003591-26.2026.8.26.0248",
"liminar":"false",
"descricaoLiminar":"Não há",
"breveResumo":"A parte autora alega que foi vítima de fraude, visto que não reconhece contratação do empréstimo consignado."
"advogadoAgressor":"false"
"dataInicioCitacao":"46126",
"tipoAcao":"Indenizatória",
"procedimento":"Digio Consignado",
"motivoAcao":"Fraude",
"subMotivoAcao":"Falsidade Ideológica",
"parceiro":"Não se aplica",
"produto":"INSS",
"dataOrigemProblema":"46105",
"procedenciaProcesso":"AG classificação",
"advogado":"JACLENILSON MOTA DOS SANTOS",
"valorCausa":"18,510.77",
"riscoAtrelado":"Possível",
"faseAtual":"Conhecimento",
"tribunal":"TJSP",
"ordinalJurisdicao":"2",
"jurisdicao":"Vara Cível",
"uf":"SP",
"comarca":"Indaiatuba",
"juizDesembargador":"SÉRGIO FERNANDES",
"adverso":"CARLOS ALBERTO ALVES RIBEIRO",
"metodoAtualizacao":"TJSP",
"valorEstimado":"6,199.85",
"valorEstimadoContigencia":"6,199.85",
"valorPerdaPossivel":"6,199.85",
"dataBaseCm":"46126",
"dataBaseJuros":"46126",
"arquivo": [
{
"arquivo": "teste.pdf",
"tipoArquivo": "teste"
}
]
},
"files": [{
"name": "teste.pdf",
"dataArquivo": "",
"tipoArquivo": "",
"error" : false,
"location" : null,
"description" : null,
"bound" : true,
"targetName" : null,
"property" : "arquivo",
"data":""
}
]
}
}
```
#### **Resposta (202/200)**:
```json
{ "id": "20260309101539Ke2testeHPIt30kUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR" }
```
2\) **Consulta do resultado (GET)**
`/execute/single/{botId}/{request_id}?format=latest`
\- **404**: ainda processando
\- **200**: retorna o **resultado final** (ver seção “Resultado da execução”).
> **Observação importante:**
> \- Para **validação** de credenciais, consulte em **`/cached/{id}`**.
> \- Para **execução** de item, consulte em **`/execute/single/{bot}/{id}?format=latest`**.
## Resultado da execução
Quando o resultado estiver pronto (**200**), a API retorna um objeto com metadados e o payload de saída:
```json
{
"bot": "projuris-digio-documentos-inserir",
"version": "v3.0.0-dev",
"request": "20260309101539XXXXXXUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR",
"account": 1,
"user": 0021,
"cid": null,
"started": "2026-03-09T10:15:46.271-03:00[America/Sao_Paulo]",
"ended": "2026-03-09T10:16:06.58-03:00[America/Sao_Paulo]",
"taskTime": "20309ms",
"timeout": "300000ms",
"retry": "UNKNOWN",
"dry": false,
"finishedAs": "Response",
"result": {
"status": "Documento(s) inserido(s) com sucesso!",
}
}
```
### `finishedAs` (principais valores)
- **Sucesso**: `Response`, `PartialResponse`
- **Falha de negócio**: `NotAllowed`, `NotFound`, `NotConsistent`, `NotAvailable`, `Forbidden`, `BotError`, `Other`
- **Falha de ambiente/contrato/dados**: `RequestHasViolations`, `NotAndApiRequest`, `NotAccepted`, `Timeout`, `Overdue`, `Duplicate`, `UnexpectedError`, `Unknown`
- **Outras falhas técnicas**: `ProxyError`, `CaptchaError`
> **Dica**: trate **HTTP 200** com `finishedAs != Response` como “erro de negócio/ambiente”, não como sucesso.
## Campos do payload de execução
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `dry` | Não | Boolean | `false` | Execução de teste, alguns robôs não suportam este modo. |
| `bot` | **Sim** | String | — | ID do robô, consulte a documentação específica. |
| `version` | **Sim** | String | — | Versão do robô, atualmente este valor é `3.0.0-dev`. |
| `cid` | Não | String | — | Idempotência: se repetido, resposta será como item duplicado, `Duplicate`. |
| `force` | Não | Boolean | — | Força reexecução de um `cid` único. |
| `timeout` | Não | **Duration** | `5m` | Ex.: `30s`. |
| `deadline` | Não | **ZonedDateTime** | — | ISO-8601 com timezone. |
| `credentials` | Depende do robô | JSON | — | Credenciais necessárias para aquele robô. Atualmente os robôs operam apenas com credenciais salvas no cofre. |
| `data` | **Sim** | JSON | — | Payload específico do robô, consulte a documentação de cada robô. |
| `files` | Depende do robô | JSON\[\] | — | Anexos; cada item: `{ bound, property, description, name, data }` onde **`data`** é geralmente **Base64** do arquivo, mas consulte a documentação do robô para mais detalhes. |
## Descrição campos 'DATA'
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| integracao | **Sim** | String | — | O número do processo o qual será coletado os dados. |
| pasta | **Não** | String | — | Código interno da empresa |
| processo | **Sim** | String | — | Pasta do documento |
| liminar | **Não** | String | — | Data do andamento |
| descricaoLiminar | **Não** | String | — | Tipo do andamento |
| breveResumo | **Não** | String | — | Fase do andamento |
| advogadoAgressor | **Não** | String | — |
|
| dataInicioCitacao | **Não** | String | — |
|
| tipoAcao | **Sim** | String | — | Documento a ser anexado |
| procedimento |
|
|
|
|
| motivoAcao |
|
|
|
|
| subMotivoAcao |
|
|
|
|
| parceiro |
|
|
|
|
| produto |
|
|
|
|
| dataOrigemProblema |
|
|
|
|
| procedenciaProcesso |
|
|
|
|
| advogado |
|
|
|
|
| valorCausa |
|
|
|
|
| riscoAtrelado |
|
|
|
|
| faseAtual |
|
|
|
|
| tribunal |
|
|
|
|
| ordinalJurisdicao |
|
|
|
|
| jurisdicao |
|
|
|
|
| uf |
|
|
|
|
| comarca |
|
|
|
|
| juizDesembargador |
|
|
|
|
| adverso |
|
|
|
|
| metodoAtualizacao |
|
|
|
|
| valorEstimado |
|
|
|
|
| valorEstimadoContigencia |
|
|
|
|
| valorPerdaPossivel |
|
|
|
|
| dataBaseCm |
|
|
|
|
| dataBaseJuros |
|
|
|
|
## Idempotência e reexecução
- **`cid`**: identifique execuções equivalentes; se um `cid` **não for único**, o item pode retornar **`Duplicate`** sem rodar de novo.
- **`force`**: reexecuta mesmo com `cid` único. Use com cautela.
- Estratégia comum: `cid = hash` de campos críticos dentro de `data` (quando fizer sentido).
---
## Boas práticas de polling
- **Mínimo até existir resposta**: a execução de um robô pode garantir um **delay mínimo** (ex.: ≥ 5s). Ajuste o primeiro poll para logo após esse limite.
- **Intervalo**: 5–10s é razoável; 7s é um bom equilíbrio para a maioria dos casos.
- **Tempo máximo/Orçamento**: defina um tempo máximo total (ex.: 2–8 min). Se exceder, encerre e reporte “pendente/timeout local”.
- **Códigos**:
- **404** → continue esperando.
- **200** → processe o resultado.
- **401/403** → pare e corrija credenciais/permissões.
- **429** → aplique **backoff** antes de tentar de novo.
---
## Tratamento de erros
- **401/403**: token inválido/sem permissão → revise `X-Oystr-Auth` / escopos.
- **404** no endpoint de resultado: item ainda processando → continue o polling.
- **429**: limite de taxa → aumente o intervalo (backoff) e tente de novo.
- **4xx no POST**: violações de contrato (payload/versão/bot inválidos) → corrija antes de retry.
- **200 com `finishedAs` não-sucesso**: trate conforme regra de negócio; alguns permitem reexecução (`ProxyError`, `CaptchaError`).
---
## Segurança e recomendações
- **Proteja o token** (`X-Oystr-Auth`): use variáveis de ambiente/cofres; evite logs com token.
- **TLS obrigatório** (`https`).
- **User-Agent identificável** ajuda na observabilidade do lado do servidor.
- **Arquivos** em `files[].data`: envie conteúdo **Base64** do binário. Valide tamanhos/formatos aceitos conforme o robô.
# API - proconsumidor-protocolo
Formato Markdown (documentação simples)
#### Autentica um usuário com CPF e senha codificada.
##### **POST** `/auth/login`
**Requisição:**
**Headers:**
- Content-Type: application/json
**Body:**
```json
{
"login": "12345",
"pass": "e10adc3949ba59abbe56e057f20f883e",
"tokenValidation": "",
"isUsuarioConsumidor": false
}
```
**Descrição dos campos:**
- **login** (string): **CPF** do usuário, apenas números.
- **pass** (string): Senha codificada (ex: **MD5**).
- **tokenValidation** (string): Campo para token externo (pode ficar vazio).
- **isUsuarioConsumidor** (boolean): false para usuários internos, true para consumidores finais.
**Resposta 200 OK**
```json
{
"uid": "MjEXXXz",
"message": "deliverCredentials",
"jsonUser": "{\"codigoUsuario\":XXXXXXX,\"nome\":\"XXXXXXXXXXXXXXX\",\"cpf\":\"XXXXXXXXXX\",\"tipoUsuario\":\"Fornecedor\",\"nomePerfil\":\"Colaborador\",\"codigoTipoUsuario\":4,\"listaFornecedores\":[{\"codigo\":XXXXX,\"nome\":\"XXXXXXXXXXXX\",\"cpfCnpj\":\"XXXXXXXXXXXXXX\"},{\"codigo\":XXX,\"nome\":\"XXXXXXX Financeira\",\"cpfCnpj\":\"XXXXXXXXXX\"},{\"codigo\":XXXXXX,\"nome\":\"XXXXXXXX XXXXXXX\",\"cpfCnpj\":\"XXXXXXXXXX\"}],\"permissoes\":[\"gerenciar_atendimento\",\"relatorio_gerencial\"],\"codigoFornecedor\":XXXX,\"nomeFornecedor\":\"XXXXXXXXXXXXXXXX.\",\"cnpjFornecedor\":XXXXXXXXXXXXXXXXX,\"indicadorAceiteTermoUso\":true}",
"expiry": 1752683825157,
"primeiroAcesso": false,
"auth_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyODM2ODg3MTg0IiwimNvZGlnb0Zvcm5lY2Vkb3IiOjY1NSwiaXNVc3VhcmlvQ29uc3VtaWRvciI6ZmFsc2V9.T1x2r0wcHijQNey_fyjcTs9IUI4Ocwx7-Or7Nu-aYyQ"
}
```
**Respostas possíveis:**
- 401 Unauthorized: CPF ou senha inválidos.
- 500 Internal Server Error: Erro interno.
#### **Altera o fornecedor autenticado associado ao usuário logado.**
##### **PUT** `/login/818/mudar-fornecedor-autenticado`
**Requisição:**
**Headers obrigatórios:**
---
**Body da Requisição (JSON):**
---
**Respostas esperadas:**
| Código | Descrição |
|---|
| 200 | Sucesso na troca do fornecedor |
| 401 | Não autorizado (token inválido) |
| 403 | Acesso negado |
| 500 | Erro interno do servidor |
| Parâmetro | Descrição | Exemplo |
|---|
| `numero` | Número do atendimento ou acompanhamento | XXXXXXXXXXXXXX |
| Código | Descrição |
|---|
| 404 | Atendimento não encontrado |
| 401 | Não autorizado (token inválido) |
| 500 | Erro interno no servidor |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `2XXXXXXXXXXXXXXXXX503` |
Prezados,\n
Lorem Ipsum é simplesmente uma simulação de texto da indústria tipográfica e de impressos, e vem sendo utilizado desde o século XVI, quando um impressor desconhecido pegou uma bandeja de tipos e os embaralhou para fazer um livro de modelos de tipos. Lorem Ipsum sobreviveu não só a cinco séculos, como também ao salto para a editoração eletrônica, permanecendo essencialmente inalterado. Se popularizou na década de 60, quando a Letraset lançou decalques contendo passagens de Lorem Ipsum, e mais recentemente quando passou a ser integrado a softwares de editoração eletrônica como Aldus PageMaker.,\n
\n\n\n\n\n\n\n\n\n\n\n\nMBA\nAdvogados
",
"consideracoesCredenciada": null,
"textoNotificacaoConsumidor": null,
"textoNotificacaoProcurador": null,
"tipoResultado": null,
"codigoFornecedor": 1,
"nomeFornecedor": null,
"codigoConsumidor": 20000000-111,
"nomeConsumidor": "ZXXXXXXXX XXXXXX XX da Silva ",
"dataRetornoConsumidor": 1726282800000,
"codigoProcurador": null,
"nomeProcurador": null,
"indicadorDescumprimentoAcordo": null,
"fornecedores": [
{
"textoNotificacao": "TERMO DE NOTIFICAÇÃO - CARTA ELETRÔNICA
Número de Atendimento: 2407072600100050301
Lorem Ipsum é simplesmente uma simulação de texto da indústria tipográfica e de impressos, e vem sendo utilizado desde o século XVI, quando um impressor desconhecido pegou uma bandeja de tipos e os embaralhou para fazer um livro de modelos de tipos. Lorem Ipsum sobreviveu não só a cinco séculos, como também ao salto para a editoração eletrônica, permanecendo essencialmente inalterado. Se popularizou na década de 60, quando a Letraset lançou decalques contendo passagens de Lorem Ipsum, e mais recentemente quando passou a ser integrado a softwares de editoração eletrônica como Aldus PageMaker. termos dos artigos 45, 46 e 47 do Decreto 2.181/97, além das possíveis sanções administrativas previstas no Código Defesa do Consumidor e legislações correlatas.
31 de Julho de 2024
",
"dataAvisoRecebimento": null,
"indicadorRespostaFornecedor": true,
"indicadorPrazoProrrogado": false,
"dataPrazoRespostaFornecedor": "2024-08-10",
"indicadorParticipacaoEletronica": true,
"indicadorParticipacaoCancelada": false,
"indicadorAtendimentoEletronico": true,
"respostaFornecedor": {
"data": 1723005879673,
"texto": "Prezados,\n
Segue\ndefesa administrativa referente a reclamação em questão do fornecedor FACTA\nFINANCEIRA S.A. CRÉDITO, FINANCIAMENTO E INVESTIMENTO.
Atenciosamente,\n
\n\n\n\n\n\n\n\n\n\n\n\nMBA\nAdvogados
",
"anexos": [
{
"chavePrimaria": {
"ano": 24,
"mes": 7,
"credenciada": 1461160,
"postoAtendimento": 1461161,
"numeroSequencial": 50,
"dataAbertura": 1722433130149,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 1
},
"nome": "2XXXXXXXXXXXXXXXXXX1 DEFESA ADMINISTRATIVA.pdf",
"dataInclusao": 1723005899531,
"tamanhoArquivo": 241799,
"objectKey": "172XXXXXX31_ee32c_680.pdf",
"tamanhoArquivoStorage": 241799,
"numeroSequencial": 1
},
{
"chavePrimaria": {
"ano": 24,
"mes": 7,
"credenciada": 1461160,
"postoAtendimento": 1461161,
"numeroSequencial": 50,
"dataAbertura": 1722433130149,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 2
},
"nome": "PROCURAÇÃO FACTA.pdf",
"dataInclusao": 1723005905205,
"tamanhoArquivo": 996121,
"objectKey": "172XXXXX205_c3e5f_68b.pdf",
"tamanhoArquivoStorage": 996121,
"numeroSequencial": 2
}
]
},
"numeroFornecedorAtendimento": 1
}
],
"fornecedoresDetails": [
{
"codigoFornecedor": 8XX,
"numeroFornecedorAtendimento": 1,
"nome": "Facta Financeira",
"numeroAtendimentoFormatado": "2X.XX.XXXX.XXX.XXXXX-XXX",
"indicadorAtendimentoEletronico": true,
"indicadorSuspensaoAtendimentoEletronico": false,
"atendimentoCancelado": false,
"telefones": [
{
"codigo": 3,
"codigoArea": "51",
"telefone": "3XXXXX8",
"tipo": {
"codigoTipoTelefone": 6,
"nomeTipoTelefone": "Institucional"
}
},
{
"codigo": 4,
"codigoArea": "61",
"telefone": "9XXXXXXX8",
"tipo": {
"codigoTipoTelefone": 2,
"nomeTipoTelefone": "Celular"
}
}
]
}
]
}
],
"responseAttrs": {}
}
```
---
**Respostas esperadas:**
| Código | Descrição |
|---|
| 400 | Erro de parâmetros |
| 401 | Não autorizado |
| 500 | Erro interno |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `24070726001000503` |
| `dataAbertura` | string | ✅ Sim | Data de abertura no formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss | 2024-07-08 ou 2024-07-08T10:00:00 |
**Headers Obrigatórios**
TERMO DE NOTIFICAÇÃO - CARTA ELETRÔNICA
Número de Atendimento: 2406031700100176301
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum., além das possíveis sanções administrativas previstas no Código Defesa do Consumidor e legislações correlatas.
10 de Julho de 2024
",
"dataAvisoRecebimento": null,
"indicadorRespostaFornecedor": true,
"indicadorPrazoProrrogado": false,
"dataPrazoRespostaFornecedor": "2024-07-20",
"indicadorParticipacaoEletronica": true,
"indicadorParticipacaoCancelada": false,
"indicadorAtendimentoEletronico": true,
"respostaFornecedor": {
"data": 1721151781641,
"texto": "",
"anexos": [
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 10000210,
"postoAtendimento": 25451,
"numeroSequencial": 176,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 1
},
"nome": "DEFESA ADMINISTRATIVA PEDRO.pdf",
"dataInclusao": 1721151769225,
"tamanhoArquivo": 312446,
"objectKey": "1721769225_661e1_251.pdf",
"tamanhoArquivoStorage": 312446,
"numeroSequencial": 1
},
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 22000,
"postoAtendimento": 55441,
"numeroSequencial": 364,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 2
},
"nome": "PROCURAÇÃO FXXXX PXXXXON - Copia.pdf",
"dataInclusao": 1721151818284,
"tamanhoArquivo": 1708876,
"objectKey": "172XX1818284_da873_30e.pdf",
"tamanhoArquivoStorage": 1708876,
"numeroSequencial": 2
}
]
},
"numeroFornecedorAtendimento": 1
}
],
"fornecedoresDetails": null
},
"responseAttrs": {}
}
```
**Respostas possíveis**
| Código HTTP | Descrição |
|---|
| `401` | Não autorizado (token inválido/expirado) |
| `403` | Acesso negado |
| `404` | Protocolo não encontrada |
| `500` | Erro interno no servidor |
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| `numeroAcompanhamento` | string | ✅ Sim | Número de acompanhamento da reclamação | `24070726001000503` |
| `dataAbertura` | string | ✅ Sim | Data de abertura no formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss | 2024-07-08 ou 2024-07-08T10:00:00 |
**Headers Obrigatórios**
TERMO DE NOTIFICAÇÃO - CARTA ELETRÔNICA
Número de Atendimento: 2406031700100176301
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum., além das possíveis sanções administrativas previstas no Código Defesa do Consumidor e legislações correlatas.
10 de Julho de 2024
",
"dataAvisoRecebimento": null,
"indicadorRespostaFornecedor": true,
"indicadorPrazoProrrogado": false,
"dataPrazoRespostaFornecedor": "2024-07-20",
"indicadorParticipacaoEletronica": true,
"indicadorParticipacaoCancelada": false,
"indicadorAtendimentoEletronico": true,
"respostaFornecedor": {
"data": 1721151781641,
"texto": "",
"anexos": [
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 10000210,
"postoAtendimento": 25451,
"numeroSequencial": 176,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 1
},
"nome": "DEFESA ADMINISTRATIVA PEDRO.pdf",
"dataInclusao": 1721151769225,
"tamanhoArquivo": 312446,
"objectKey": "1721769225_661e1_251.pdf",
"tamanhoArquivoStorage": 312446,
"numeroSequencial": 1
},
{
"chavePrimaria": {
"ano": 24,
"mes": 6,
"credenciada": 22000,
"postoAtendimento": 55441,
"numeroSequencial": 364,
"dataAbertura": 1720638951263,
"numeroFornecedorAtendimento": 1,
"numeroSequencialAnexo": 2
},
"nome": "PROCURAÇÃO FXXXX PXXXXON - Copia.pdf",
"dataInclusao": 1721151818284,
"tamanhoArquivo": 1708876,
"objectKey": "172XX1818284_da873_30e.pdf",
"tamanhoArquivoStorage": 1708876,
"numeroSequencial": 2
}
]
},
"numeroFornecedorAtendimento": 1
}
],
"fornecedoresDetails": null
},
"responseAttrs": {}
}
```
#### **Anexar arquivo na resposta do fornecedor**
**POST `/resposta-fornecedor`**
**Payload da requisição**
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|
| indicadorHouveRespostaFornecedor | Boolean | sim | Indica se houve resposta | true/false |
| codigoFornecedor | int | sim | Código do fornecedor | 123123 |
| nomeFornecedor | string | sim | Nome do fornecedor | Aaaa Bbbb |
| indicadorAtendimentoEletronico | Boolean | sim | Indica o se foi atendimento eletrônico | true/false |
| numeroFornecedorAtendimento | int | sim | Número do fornecedor atendido | 321321 |
| dataRespostaFornecedor | string | sim | Data da resposta | dd/mm/yyyy |
| textoRespostaFornecedor | string | sim | Descrição da resposta |
|
| anexos | List | sim | Arquivos para upload | 123Exemplo.pdf |
| ano | int | sim | Ano em que foi feito o protocolo | 2025 |
| mes | int | sim | Mês em que foi feito o protocolo | 07 |
| codigoCredenciada | int | sim | Código da credenciada | 54321 |
| codigoPosto | int | sim | Código do posto | 53412 |
| numeroSequencial | int | sim | Número sequencial do protocolo | 123454321 |
| dataAbertura | Long | sim | Data da abertura do protocolo | dd/mm/yyyy |
| indicadorTratativaMaisRecente | Boolean | sim | Indica se houve tratativa mais recente | true/false |
| Código HTTP | Descrição |
|---|
| `401` | Não autorizado (token inválido/expirado) |
| `403` | Acesso negado |
| `404` | Protocolo não encontrada |
| `500` | Erro interno no servidor |
| Campo | Obrigatório | Tipo | Default | Descrição |
|---|
| `numeroDossie` | **Sim** | String | — | O número do processo o qual será coletado os dados. |
- **`POST`**: `ASYNC` `/execute/single` **Content-Type: `JSON`**
```
{
"dry": false,
"bot": "id-do-robo",
"version": "v3.0.0-dev",
"credentials": {
"username": "usuario",
"password": "senha"
},
"data":
{
"numeroDossie":"2023/8XXXX-X"
}
}
```
- Esta requisição é [assíncrona](https://wiki.oystr.com.br/link/265#bkmrk-respostas-ass%C3%ADncrona).
#### **Resultado da execução**
- Quando o resultado estiver pronto (**200**), a API retorna um objeto com metadados e o payload de saída:
```
{
"bot": "exyon-bmg-info",
"version": "v3.0.0-dev",
"request": "20260309101539XXXXXXUUH1vlbNX8v33KnLgGyrF9sTX13ZVL0bR",
"account": 1,
"user": 0021,
"cid": null,
"started": "2026-03-09T10:15:46.271-03:00[America/Sao_Paulo]",
"ended": "2026-03-09T10:16:06.58-03:00[America/Sao_Paulo]",
"taskTime": "20309ms",
"timeout": "300000ms",
"retry": "UNKNOWN",
"dry": false,
"finishedAs": "Response",
"result": {
"status": "Coleta baixada com sucesso",
"numeroProcesso": "52XXXX72025XXXXX21",
"dataInicio": "14/08/2025",
"pais": "BRASIL",
"municipio": "PASSO FUNDO",
"numeral": "04",
"instancia": "PRIMEIRA",
"area": "SUBSÍDIOS BMG EM CONTA",
"acao": "AÇÃO INDENIZATÓRIA",
"juizo": null,
"uf": "RIO GRANDE DO SUL",
"orgaoTribunal": "TRIBUNAL DE JUSTIÇA - RIO GRANDE DO SUL",
"denominacaoVara": "VARA CÍVEL",
"esfera": "JUSTIÇA ESTADUAL",
"assunto": "BMG EM CONTA",
"rito": "RITO ORDINÁRIO",
"escrevente": "",
"codigoPoloAtivo": "XXX75XXX3",
"nomePoloAtivo": "SXXXXX AXXXXXXXO NXXXXS",
"qualificacaoPoloAtivo": "PARTE AUTORA",
"codigoPoloPassivo": "XX60325XXX",
"nomePoloPassivo": "BANCO BMG",
"qualificacaoPoloPassivo": "PARTE RÉU",
"valorInicial": "8.150,28"
}
}
```
Diferentes [tipos de erro](https://wiki.oystr.com.br/link/265#bkmrk-requisi%C3%A7%C3%B5es-duplicad) que você poderá encontrar.