Versionamento da API#

Cada empresa pode ser configurada para receber e enviar dados em uma versão da API. E as empresas-filhas herdam a versão da empresa-mãe no momento da criação.

  • A versão da API, por padrão, é a mais atual (6), e deve sempre ser explicitamente modificada pelo usuário. Cada mudança de versão traz funcionalidades novas e modificações provavelmente incompatíveis no nome ou formato dos campos. Mais detalhes sobre cada versão está disponível na seção “Histórico de mudanças”.

Modificar versão da API via chamada#

Realize a chamada usando um token de acesso de usuário administrador da empresa a ser modificada.

O exemplo abaixo modifica a versão da API para a 2.

cURL:

curl -X POST 'https://op.digesto.com.br/api/admin/user_company/update_admin_options' \
-H 'Content-Type: application/json' \
-H 'Host: op.digesto.com.br' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'
-d '{
    "config": {
        "api_config": 2
    }
}'

Resposta:

{
    "config": {
        "api_config": 2
    }
}

Parâmetro - Tipo - Descrição

api_config - integer - Versão da API a ser configurada

Histórico de mudanças#

Listamos abaixo as mudanças feitas em cada versão da API.

Versão 6#

  • Adiciona a instância do processo nos eventos de movimentação. Consulte as referências do schema em movimentações.

Versão 5#

  • Parâmetro incluir_parte_indefinida dos “Detalhes de processo judicial” passa a ter default true.

  • Usa como default nova definição de para os tipos de andamentos e publicações.

Versão 4#

  • Múltiplos valores possíveis para tipo inteligente de movimentações processuais

Na versão anterior da API, era permitido apenas um valor para o tipo e um para o subtipo, enviados nos campos na posição 5 e 6 de uma movimentação, conforme abaixo. Na versão 4, a API passou a usar apenas um campo na posição 5, que passa a ser uma lista de tuplas.

Segue documentação da versão anterior:

  • 5 tipo inteligente (texto), é - quando disponível - a classificação automática pelo Digesto da movimentação. Quando não disponível, o valor é null. Assume os valores abaixo por default. Pode ser expandido para capturar outros tipos de eventos relevantes para o cliente com treinamento de máquina a partir de muitos exemplos ou regras fixas (expressões e marcadores em texto):

    • ACORDO

    • AR POSITIVO

    • REVELIA

    • DEPÓSITO

    • APELAÇÃO

    • ACÓRDÃO

    • AUDIÊNCIA DESIGNADA

    • AUDIÊNCIA NÃO REALIZADA

    • AUDIÊNCIA REALIZADA

    • AUDIÊNCIA REDESIGNADA

    • CITAÇÃO EXPEDIDA

    • CONCLUSO PARA DECISÃO

    • DISTRIBUIÇÃO

    • EMBARGOS DE DECLARACAO

    • INTERPOSICAO DE APELACAO

    • INTERPOSICAO EMBARGOS DECLARACAO

    • JUNTADA DE CITACAO

    • JUNTADA DE CONTESTACAO

    • LIMINAR INDEFERIDA

    • LIMINAR (quando houver indícios de que foi Deferida)

    • SENTENÇA

    • TRANSITO EM JULGADO

  • 6 subtipo inteligente (texto), é - quando disponível - o subtipo da classificação automática pelo Digesto da movimentação. Normalmente usado por exemplo para indicar se a sentença é positiva, se houve acordo etc. Exemplo de possíveis valores:

    • ACORDO

    • DESISTENCIA AUTOR

    • NEGATIVA

  • Múltiplos valores possíveis para tipo inteligente de publicações processuais

    Mudança análoga à acima. Na versão anterior, o campo assunto_norm de uma publicação era tupla de identificadores uniformes entre os tribunais indicando o tipo principal e secundário de movimentação. A lista completa com descrição de cada fonte está disponível em Padronização dos tipos para andamentos e publicações processuais.

Versão 3#

  • Novo campo de uma parte de processo judicial: Parte é pessoa fisica ou jurídica

Versão 2#

  • Novos campos nos detalhes de processo judicial:

    • Polo

    • Classe/Natureza padronizada pela Digesto

    • Acessos ao processo

    • ID Parte monitorada

    • CEP do autor