Clientes#

Na API, um cliente representa uma companhia cadastrada para gerenciar intimações judiciais e outros recursos relacionados. Essa estrutura permite ao cliente automatizar a rotina jurídica, garantindo um acompanhamento eficiente e centralizado das intimações eletrônicas em múltiplos tribunais de justiça.

Contas#

As contas correspondem às credenciais de um cliente em um tribunal específico. Cada conta registrada deve conter informações como login, senha ou certificado digital, além de estar vinculada ao cliente e ao sistema correspondente. Por exemplo, se um cliente deseja coletar intimações eletrônicas do Tribunal de Justiça de Pernambuco, no sistema PJe, é necessário cadastrar a conta com credenciais válidas e especificar o tribunal desejado, TJPE-PJe.

Perfis#

Os perfis são utilizados para agrupar notificações vinculadas a uma conta específica, permitindo que um advogado, que pode representar várias empresas, identifique claramente as notificações de cada cliente. Essa funcionalidade reflete a organização interna dos sistemas judiciais, evitando que notificações de diferentes representados sejam agrupadas desnecessariamente. Cada conta deve possuir ao menos um perfil habilitado para a coleta.

Endpoints#

Listar Contas Cadastradas#

Este endpoint retorna uma lista de todas as contas cadastradas para um cliente.

Exemplo de chamada:

curl -X GET 'op.digesto.com.br/api/legal-deadlines/contas?page=1&per_page=10' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json'

Parâmetros

Parâmetro	Tipo	Descrição
page	int (query)	Número da página a ser retornada.
per_page	int (query)	Quantidade de resultados por página.

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "acessar_todos_perfis": false,
        "data_expiracao_certificado": "2024-11-12T21:36:09.485Z",
        "id": 1,
        "instancia": 2,
        "realizar_leitura": true,
        "sistema": {
            "id": 5,
            "nome_normalizado": "PJe"
        },
        "tipo_acesso": "Certificado Digital",
        "ultimo_status": "not yet executed",
        "usuario": "usuario@exemplo.com"
    },
    {
        "acessar_todos_perfis": true,
        "arquivado_em": "2023-10-10T10:10:10.000Z",
        "arquivado_por": "Administrador",
        "id": 2,
        "instancia": 1,
        "realizar_leitura": false,
        "sistema": {
            "id": 6,
            "nome_normalizado": "e-SAJ"
        },
        "tipo_acesso": "Login e Senha",
        "ultimo_status": "completed",
        "usuario": "outro.usuario@exemplo.com"
    }
]

Erros

404 Not Found: Cliente não encontrado.
422 Validation Error: Erro de validação nos parâmetros.

Cadastrar Conta#

Este endpoint permite o cadastro de uma nova conta para um cliente.

Exemplo de chamada:

curl -X POST 'op.digesto.com.br/api/legal-deadlines/contas' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
    "acessar_todos_perfis": true,
    "acessar_todos_tribunais": true,
    "certificado_b64": "-----BEGIN CERTIFICATE-----...",
    "instancia": 1,
    "ler_tudo": true,
    "senha": "*Password456",
    "senha_pfx": "#password456",
    "sistema_id": 3,
    "tipo_acesso": "parte",
    "uri_2fa": "otpauth://totp/MinhaEmpresa:usuario@exemplo.com?secret=...",
    "usuario": "user123"
}'

Resposta

HTTP/1.1 201 CREATED
Content-Type: application/json

{
    "id": 1,
    "usuario": "user123"
}

Erros

400 Bad Request: Erro de validação no cadastro.
404 Not Found: Cliente ou sistema não encontrado.
422 Validation Error: Erro de validação nos parâmetros.

Remover Conta#

Este endpoint desabilita uma conta cadastrada.

Exemplo de chamada:

curl -X DELETE 'op.digesto.com.br/api/legal-deadlines/contas/<conta_id>' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
    "message": "Conta removida com sucesso"
}

Erros

404 Not Found: Conta ou cliente não encontrado.
422 Validation Error: Erro de validação nos parâmetros.

Alterar Informações da Conta#

Este endpoint permite a alteração das informações de uma conta cadastrada.

Exemplo de chamada:

curl -X PATCH 'op.digesto.com.br/api/legal-deadlines/contas/<conta_id>' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "certificado_b64": "MIICoTCCAgygAwIBAgIUDOHYZg==...",
  "instancia": 2,
  "realizar_leitura": true,
  "senha": "novaSenha123",
  "senha_pfx": "senhaCertificado123",
  "uri_2fa": "otpauth://totp/MinhaEmpresa:usuario@exemplo.com?secret=..."
}'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
    "message": "Conta atualizada com sucesso"
}

Erros

400 Bad Request: Erro de validação nos parâmetros.
404 Not Found: Conta ou cliente não encontrado.
422 Validation Error: Parâmetros inválidos.

Selecionar Perfis#

Este endpoint seleciona os perfis habilitados ou desabilitados para uma conta.

Exemplo de chamada:

curl -X PATCH 'op.digesto.com.br/api/legal-deadlines/contas/<conta_id>/perfis' \
     -H 'Authorization: Bearer token' \
     -H 'Content-Type: application/json' \
     -d '{
           "acessar_todos_perfis": true,
           "ids_desabilitar": [7, 9],
           "ids_habilitar": [1, 2, 3]
         }'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
    "message": "Configurações de perfil alteradas"
}

Erros

400 Bad Request: Nenhum ID informado.
404 Not Found: Conta ou cliente não encontrado.
422 Validation Error: Erro de validação nos parâmetros.

Selecionar Tribunais#

Este endpoint habilita ou desabilita tribunais para leitura em uma conta.

Exemplo de chamada:

curl -X PATCH 'op.digesto.com.br/api/legal-deadlines/contas/<conta_id>/tribunais' \
     -H 'Authorization: Bearer token' \
     -H 'Content-Type: application/json' \
     -d '{
           "acessar_todos_tribunais": true,
           "ids_desabilitar": [],
           "ids_habilitar": []
         }'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
    "message": "Configurações de tribunal alteradas"
}

Erros

400 Bad Request: Nenhum ID informado.
404 Not Found: Conta ou cliente não encontrado.
422 Validation Error: Erro de validação nos parâmetros.