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": "default",
        "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": "default",
        "ultimo_status": "completed",
        "usuario": "outro.usuario@exemplo.com"
    }
]

Erros

  • 404 Not Found: Cliente não encontrado.

  • 422 Unprocessable Entity: Parâmetros de paginação inválidos (ex: page ou per_page com valor não inteiro).

  • 503 Service Unavailable: Serviço temporariamente indisponível. Tente novamente em alguns instantes.

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"
}'

Valores válidos para tipo_acesso

O campo tipo_acesso define o perfil de acesso utilizado pelo robô no sistema judicial. Os valores aceitos variam conforme o grupo de sistema ao qual a conta pertence:

Grupo de sistema

Exemplos de tribunais

Valores aceitos

TJBA Projudi

TJBA

representante

TJMG / TJPI / TJMT Projudi

TJMG, TJPI, TJMT

parte-cnpj

TJAM Projudi

TJAM

parte

TJPR Projudi

TJPR

gerente-advocacia, representante-legal

TJRR Projudi

TJRR

procurador, gerente-procuradoria

Demais Sistemas

PJe, e-SAJ, PDPJ e outros

default

Caso o valor informado não seja compatível com o sistema da conta, a API retornará 400 Bad Request com a mensagem tipo_acesso <valor> não aceito para o sistema <nome>.

Resposta

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

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

Erros

  • 400 Bad Request: A requisição foi rejeitada por uma regra de negócio do serviço de intimações. O campo message da resposta detalha o motivo. Exemplos:

    • tipo_acesso <valor> não aceito para o sistema <nome> — o tipo de acesso não é compatível com o sistema selecionado.

    • A URI semente da 2FA não foi informada no cadastro — o sistema exige MFA, mas o campo uri_2fa não foi fornecido.

    • instância <n> não aceita no sistema — o valor de instancia não é suportado pelo sistema especificado.

    • Senha e certificado PFX devem ser informados — o sistema exige certificado digital, mas senha_pfx e/ou certificado_b64 estão ausentes.

    • Sistema não permite seleção de tribunais — o sistema não suporta acessar_todos_tribunais=false com seleção de tribunais individuais.

  • 404 Not Found: sistema_id informado não encontrado, ou cliente não cadastrado.

  • 422 Unprocessable Entity: Falha na validação do payload. O campo detail lista os erros. Exemplos:

    • Certificado deve estar em base64 — o valor de certificado_b64 não é um Base64 válido.

    • Tipo de acesso "<valor>" não é permitido. Tipos de acesso permitidos por sistema — ... — o tipo_acesso não pertence à lista de valores aceitos: representante, parte-cnpj, parte, gerente-advocacia, representante-legal, procurador, gerente-procuradoria ou default.

  • 503 Service Unavailable: Serviço temporariamente indisponível. Tente novamente em alguns instantes.

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 Unprocessable Entity: Parâmetros inválidos (ex: conta_id não inteiro).

  • 503 Service Unavailable: Serviço temporariamente indisponível. Tente novamente em alguns instantes.

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 da conta.

  • 404 Not Found: Conta ou cliente não encontrado.

  • 422 Unprocessable Entity: Falha na validação do payload. O campo detail lista os erros. Exemplo:

    • Certificado deve estar em base64 — o valor de certificado_b64 não é um Base64 válido.

  • 503 Service Unavailable: Serviço temporariamente indisponível. Tente novamente em alguns instantes.

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": false,
           "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

  • 404 Not Found: Conta ou cliente não encontrado.

  • 422 Unprocessable Entity: Falha na validação do payload. O campo detail lista os erros. Exemplos:

    • É necessário informar ao menos um id de perfil para habilitar, desabilitar ou a opção de acessar todos os perfis — o payload não contém nenhuma ação válida.

    • Não é permitido informar ids de perfis quando a opção de acessar todos os perfis está selecionada — acessar_todos_perfis=true é exclusivo e não pode ser combinado com ids_habilitar ou ids_desabilitar.

  • 503 Service Unavailable: Serviço temporariamente indisponível. Tente novamente em alguns instantes.

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: A conta não está vinculada ao sistema PDPJ e não aceita seleção individualizada de tribunais (Seleção de tribunais se dá apenas para contas vinculadas ao sistema PDPJ).

  • 404 Not Found: Conta ou cliente não encontrado.

  • 422 Unprocessable Entity: Falha na validação do payload. O campo detail lista os erros. Exemplos:

    • É necessário informar ao menos um id de tribunal para habilitar, desabilitar ou a opção de acessar todos os tribunais — o payload não contém nenhuma ação válida.

    • Não é permitido informar ids de tribunais quando a opção de acessar todos os tribunais está selecionada — acessar_todos_tribunais=true é exclusivo e não pode ser combinado com ids_habilitar ou ids_desabilitar.

  • 503 Service Unavailable: Serviço temporariamente indisponível. Tente novamente em alguns instantes.