Envio ofício (XML)

Descrever o serviço responsável pelo envio de ofícios. Esse serviço possibilita a transmissão dos documentos em formato XML via webservice, oferecendo uma alternativa ao envio manual realizado pelo sistema.

Com essa implementação, busca-se garantir maior agilidade, padronização e eficiência para comunicação entre o apresentante e a CRA21, permitindo a integração com outros sistemas e facilitando o processamento de grandes volumes de dados. O envio manual permanece disponível, garantindo flexibilidade na adoção do novo método.

  • Homologação (ambiente de testes):

craUF.cra21.com.br/craUF/xml/protestos.php?wsdl

Ex: https://cradf.cra21.com.br/cradf/xml/protestos.php?wsdl

ATENÇÃO: no ambiente de homologação utilizar o protocolo HTTPS
  • Produção (ambiente de funcionamento do sistema):

craUF.crabr.com.br/craUF/xml/protestos.php?wsdl


Ex: https://cradf.crabr.com.br/cradf/xml/protesto.php?wsdl

ATENÇÃO: no ambiente de produção utilizar o protocolo HTTPS

  • Os dados (parâmetros) devem ser enviados via protocolo SOAP
  • Ao consumir o WebService, em todos os serviços, a autenticação deverá ser realizada utilizando autenticação básica.
    • Deverão ser passados os parâmetros de usuário e senha, fornecidos pela CRA.
    • Após a autenticação serão validados os parâmetros de entrada e por último a crítica do arquivo
  • Serviços disponíveis:
    • Oficio_Titulo Envio de ofício
  • Parâmetros dos serviços disponíveis:
    • Upload
      userArq Nome do arquivo no formato OTNNNDDMM.AAS.
      userDados Conteúdo do arquivo XML.
    • O encoding do XML deve estar de acordo com ISO-8859-1.
    • O conteúdo dos arquivos enviados para CRA devem seguir o padrão de codificação ASCII

EMOLUMENTOS

  • OTNNNDDMM.AAS, onde:
    • OT: constante que indica ser arquivo de ofício;
    • NNN: constante 000;
    • DD: dia;
    • MM: mês;
    • AA: ano de referência;
    • S: sequencial do arquivo (mínimo 1, máximo 9).Ex: OT0000404.221

REGISTRO – ARQUIVO OFÍCIO

CLIQUE AQUI E BAIXE O EXEMPLO DO ARQUIVO DE OFÍCIO
Atributo Descrição Tam Tipo Casas Decimais Obrigatório
CodMun Código IBGE do município Variável Numérico Nenhuma Sim
numero_cartorio código do cartório
 Variável Numérico Nenhuma Sim
numero_protocolo protocolo Variável Alfanumérico Nenhuma Sim
data_protocolo Data de protocolo 008 Data (01012025) Nenhuma Sim
numero_titulo Número do título Variável Alfanumérico Nenhuma Sim
nome_devedor
 Nome do devedor
 Variável Alfanumérico Nenhuma Sim
valor valor Variável Decimal 2 Sim
tipo_oficio
Tipo Descrição
0 Suspensão/Sustação
1 Revogação
2 Cancelamento Desistência
99 Outros
Variável numérico Nenhuma Sim
observacao Observação Variável Alfanumérico Nenhuma Não
imagem Imagem (base64) Variável Alfanumérico Nenhuma Sim

Observações:

  1. O envio do ofício prevê o preenchimento dos campos em destaque.

Mensagens

  • SOLICITAÇÃO RECEBIDA COM SUCESSO
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>0000</codigo>
    <descricao>SOLICITAÇÃO RECEBIDA COM SUCESSO</descricao>
</mensagem>
  • NUMERO DO PROTOCOLO EM BRANCO
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2004</codigo>
    <descricao>NUMERO DO PROTOCOLO EM BRANCO>
</mensagem>
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2005</codigo>
    <descricao>NUMERO DO PROTOCOLO INVÁLIDO>
</mensagem>
  • NUMERO DO PROTOCOLO DEVE CONTER NO MAXIMO 10 DIGITOS
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2006</codigo>
    <descricao>NUMERO DO PROTOCOLO DEVE CONTER NO MAXIMO 10 DIGITOS>
</mensagem>
  • DATA DO PROTOCOLO (%s) INVÁLIDA
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2007</codigo>
    <descricao>DATA DO PROTOCOLO (%s) INVÁLIDA>
</mensagem>
  • NUMERO DO TITULO EM BRANCO
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2008</codigo>
    <descricao>NUMERO DO TITULO EM BRANCO>
</mensagem>
  • NUMERO DO TITULO DEVE CONTER NO MAXIMO 11 DIGITOS
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2008</codigo>
    <descricao>NUMERO DO TITULO DEVE CONTER NO MAXIMO 11 DIGITOS>
</mensagem>
  • NOME DO DEVEDOR EM BRANCO
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2009</codigo>
    <descricao>NOME DO DEVEDOR EM BRANCO>
</mensagem>
  • VALOR DO TITULO INVÁLIDO
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2010</codigo>
    <descricao>VALOR DO TITULO INVÁLIDO>
</mensagem>
  • TITULO NAO ENCONTRADO
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2012</codigo>
    <descricao>TITULO NAO ENCONTRADO>
</mensagem>
  • IMAGEM INVÁLIDA, ASSINADA INCORRETAMENTE OU ASSINANTE NÃO AUTORIZADO
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2018</codigo>
    <descricao>IMAGEM INVÁLIDA, ASSINADA INCORRETAMENTE OU ASSINANTE NÃO AUTORIZADO>
</mensagem>
  • OFÍCIO EM DUPLICIDADE
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2036</codigo>
    <descricao>OFÍCIO EM DUPLICIDADE>
</mensagem>
  • TIPO OFÍCIO INVÁLIDO
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2037</codigo>
    <descricao>TIPO OFÍCIO INVÁLIDO>
</mensagem>
  • FALTOU INFORMAR A TAG: IMAGEM
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2038</codigo>
    <descricao>FALTOU INFORMAR A TAG: IMAGEM>
</mensagem>
  • FALTOU INFORMAR A TAG: TIPO OFÍCIO
1
2
3
4
5

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<mensagem>
    <codigo>2039</codigo>
    <descricao>FALTOU INFORMAR A TAG: TIPO OFÍCIO>
</mensagem>

Mensagens

CÓDIGO DESCRIÇÃO
0000 SOLICITAÇÃO RECEBIDA COM SUCESSO.
2004 NUMERO DO PROTOCOLO EM BRANCO
2005 NUMERO DO PROTOCOLO INVÁLIDO
2006 NUMERO DO PROTOCOLO DEVE CONTER NO MAXIMO 10 DIGITOS
2007 DATA DO PROTOCOLO (%s) INVÁLIDA
2008 NUMERO DO TITULO EM BRANCO
2008 NUMERO DO TITULO DEVE CONTER NO MAXIMO 11 DIGITOS
2009 NOME DO DEVEDOR EM BRANCO
2010 VALOR DO TITULO INVÁLIDO
2012 TITULO NAO ENCONTRADO
2018 IMAGEM INVÁLIDA, ASSINADA INCORRETAMENTE OU ASSINANTE NÃO AUTORIZADO
2036 OFÍCIO EM DUPLICIDADE
2037 TIPO OFÍCIO INVÁLIDO
2038 FALTOU INFORMAR A TAG: IMAGEM
2039 FALTOU INFORMAR A TAG: TIPO OFÍCIO