Integração com a API do Cartório Online

# Integração com a API do Cartório Online

# 1º passo: Adquirir um token de acesso

Para obter o token JWT é necessário realizar uma requisição no serviço de autenticação:

# Endpoint:

https://apievolution.escriba.com.br/oauth/

Operação: POST

Parametro	Valor
Username	`Login de acesso`
Tenant	`Código do Tenant`
Password	`Senha de acesso`

Adicionar ao Header o valor fixo:

Authorization: Basic RUlub3ZhLXRlcm1pbmFsOmUzYjJiZWQ4NTM3ZjQzNzZhNjJlNmZmZjE5NjNjNWIw

# Exemplo:

Supondo que os dados de acesso sejam:

Tenant: 57
Username: escriba
Password: 123456

A requisição será feita dessa forma:

curl --request POST \
  --url 'https://apievolution.escriba.com.br/oauth/token?grant_type=password&tenant=57&username=escriba&password=123456' \
  --header 'Authorization: Basic RUlub3ZhLXRlcm1pbmFsOmUzYjJiZWQ4NTM3ZjQzNzZhNjJlNmZmZjE5NjNjNWIw' \

Retorno: Um JSON contendo o Access Token JWT que deverá ser utilizado nas requisições de consulta.

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 1799,
  "scope": "trust read write",
  "user_tenant": "57",
  "user_id": 2,
  "user_name": "escriba",
  "user_autorizacaoID": 2,
  "user_fimLiberacao": null,
  "user_ibge": 4106902,
  "jti": "9965ascds-b76e-4991-8854-0149be2044bd"
}

Atenção

O token tem expiração de 24 horas. Após a expiração é necessário solicitar um novo token através da URL anterior.

# 1.2) Extrair token de acessso

Recebendo o código 200 da requisição anterior, deve ser extraído o campo access_token do JSON de resposta.
Todas as chamadas seguintes necessárias à API devem passar o access_token obtido no cabeçalho da requisição, no seguinte formato:

Authorization: Bearer ACCESS_TOKEN

# 2º passo: Obter a lista de solicitações no serviço Cartório Online

Realizar chamada para obter a lista de solicitações pendentes no serviço Cartório Online:
Método: GET
Recurso: https://apievolution.escriba.com.br/e-cartorio-online/v1/solicitacoes/pendentes-edicao

Retorno:
- Lista de solicitações, cada uma com:
  - Lista de compradores
  - Lista de vendedores
  - Lista de imóveis
- Cada pessoa e imóvel da lista, possui uma lista de arquivos
  - Cada arquivo é representado por um idArquivo que é chave do arquivo no serviço E-Storage
  - Observação: Cônjuges e representantes também possuem lista de documentos

# 3º passo: Obter a lista de arquivos anexos no serviço E-Storage

Para cada arquivo retornado na lista, que seja necessário importar para o sistema Notas, deve ser obtido através de uma requisição ao serviço E-Storage:
Método: GET
Recurso: https://apievolution.escriba.com.br/e-storage/v1/files/{id}

# 4º passo: Obter dados do serviço E-CEP

Quando necessário obter a descrição de localidades (cidade, estado, país), deve ser obtido através de uma requisição ao serviço E-CEP:

Localidade	Recurso
Cidade	https://apievolution.escriba.com.br/e-cep/v1/cidades/{id}
Estado	https://apievolution.escriba.com.br/e-cep/v1/estados/{id}
País	https://apievolution.escriba.com.br/e-cep/v1/paises/{id}

# 5º passo: Atualizar solicitações adquiridas pelo Notas no serviço Cartório Online

Para cada solicitação retornada na lista, que tenha sido importada com sucesso pelo sistema Notas, deve ser atualizada sua situação através de uma requisição ao serviço Cartório Online:
Método: PATCH
Serviço: https://apievolution.escriba.com.br/e-cartorio-online/v1/solicitacoes/{protocolo}/edicao-cartorio

← Api de Integração Api de Integração →