CCN - API de exportação

Modificado em Seg, 23 Mar na (o) 2:37 PM

HISTÓRICO


VersãoData da Publicação
Alterações
v1
27/01/2025

- Versão inicial


ÍNDICE


Introdução


Esse material descreve como os cartórios podem consultar os dados cadastrais da CCN por API, especificando como cadastrar os IPs e assinar as requisições.


Configuração da integração


Para consumir as APIs de exportação do CCN, o cartório deverá cadastrar os IPs onde serão executadas as APIs e subir a chave pública dos certificados digitais ICP-Brasil de quem irá consultar.


Acesse a área de Administração do sistema CCN.

Em seguida, clique no Menu Integração.
 




Cadastramento dos IPs


Acesse o menu Integração e depois selecione a opção "Exportar" para informar os endereços IPs do cartório nos quais serão executadas as APIs.



Autenticação de chave pública


Será necessário subir a chave pública dos certificados digitais ICP-Brasil do tabelião e prepostos do cartório que consultarão os dados da CCN por meio da API.


A exportação de registros no CCN exige que a requisição seja assinada para garantir a segurança e identificação do requisitante. Portanto, o certificado de um usuário ativo na organização deve realizar a assinatura digital CAdES e enviar

no cabeçalho da requisição das rotas de exportação.



Anexe a chave pública do certificado em formato .cer ou .pem (vide explicações neste material para exportar para o formato pem) 


Inclua todas as chaves públicas dos usuários que efetuarão as consultas na API.



Para maiores detalhes técnicos, consulte a documentação anexa "SE-Autenticação de chave pública"


Obter certificados no formato .pem

Pré-requisitos

openssl - Obrigatório - Conjunto de ferramentas de criptografia


curl - Opcional - Ferramenta que possibilita fazer requisições pela linha de comando

  • Windows: Para poder utilizar essas ferramentas no Windows, uma das maneiras é efetuar a instalação da ferramenta MSYS2
  • Linux: Já estão instaladas


chave privada e certificado no formato PEM - Obrigatório

  • Extrair a chave privada do arquivo PFX e salvar no formato PEM.
    openssl pkcs12 -legacy -in certificado.pfx -nodes -out certificado.private.pem

  • Extrair o certificado do arquivo PFX e salvar no formato PEM.
    openssl pkcs12 -legacy -in certificado.pfx -nokeys -out certificado.public.pem



Este artigo foi útil?

Que bom!

Obrigado pelo seu feedback

Desculpe! Não conseguimos ajudar você

Obrigado pelo seu feedback

Deixe-nos saber como podemos melhorar este artigo!

Selecione pelo menos um dos motivos
A verificação do CAPTCHA é obrigatória.

Feedback enviado

Agradecemos seu esforço e tentaremos corrigir o artigo