Companies#

Cada credencial deve estar vinculada a uma empresa, representada pela entidade Company.

Uma empresa é identificada por um CNPJ e deve conter os seguintes campos:

  • cnpj: número do Cadastro Nacional da Pessoa Jurídica (obrigatório);

  • name: nome da empresa (obrigatório);

  • description: descrição adicional da empresa (opcional).

Esses dados, juntamente com as informações contidas no token de autenticação, são utilizados para associar corretamente as credenciais à empresa e ao usuário responsável pelo cadastro.

Cadastrar Empresa#

Para cadastrar uma nova empresa via API do Procon, envie a seguinte requisição:

curl --request POST 'http://op.digesto.com.br/api/prazos_judiciais/companies' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <token>' \
     --data-raw '{
         "name": "Company Procon Ltda.",
         "cnpj": "12345678011195",
         "description": "Company para teste no jus-solucoes-op-api"
     }'

Headers

Nome

Tipo

Obrigatório

Descrição

Authorization

string

Sim

Token de autenticação (formato Bearer).

Content-Type

string

Sim

Deve ser application/json.

Corpo da Requisição (JSON)

Campo

Tipo

Obrigatório

Descrição

name

string

Sim

Nome da empresa.

cnpj

string

Sim

CNPJ da empresa.

description

string

Não

Texto descritivo da empresa (uso interno).

O token enviado na requisição carrega os dados do usuário autenticado, previamente associado a uma empresa no OP. Com base nessas informações e nos dados fornecidos no corpo da requisição, a API realiza automaticamente o vínculo da nova empresa no banco de dados do Procon, tornando-a apta para receber credenciais.

Resposta esperada:

{
    "name": "Company Procon Ltda.",
    "cnpj": "12345678011195",
    "description": "Company para teste no jus-solucoes-op-api",
    "id": 85,
    "dg_created_at": "2025-07-11T21:37:19.158677"
}

Listar Empresas#

Uma vez cadastradas, as empresas vinculadas ao token de autenticação podem ser listadas com a seguinte requisição:

curl --request GET \
     --url https://op.digesto.com.br/api/prazos_judiciais/companies \
     --header 'Authorization: Bearer <token>'

Headers

Nome

Tipo

Obrigatório

Descrição

Authorization

string

Sim

Token de autenticação (formato Bearer).

Query Params

Nome

Tipo

Obrigatório

Descrição

where

string

Não

Filtro em JSON (URL encoded), ex: {“id”: 88}

page

int

Não

Número da página a ser retornada (padrão: 1).

per_page

int

Não

Quantidade de itens por página (padrão: 30, máximo: variável).

Exemplo de resposta:

[
    {
        "id": 88,
        "name": "Company Procon Teste 1 Ltda.",
        "cnpj": "35175769000125",
        "description": "Company para teste 1 no jus-solucoes-op-api",
        "dg_created_at": "2025-07-16T14:14:07.804783"
    },
    {
        "id": 87,
        "name": "Company Procon Ltda.",
        "cnpj": "47996680000109",
        "description": "Company para teste no jus-solucoes-op-api",
        "dg_created_at": "2025-07-16T14:13:46.553110"
    },
    {
        "id": 86,
        "name": "Company Procon Teste 3 Ltda.",
        "cnpj": "20372535000109",
        "description": "Company para teste 3 no jus-solucoes-op-api",
        "dg_created_at": "2025-07-16T13:56:18.814845"
    }
]

Exemplo de headers da resposta:

date: Tue, 22 Jul 2025 18:15:11 GMT
content-type: application/json
content-length: 691
x-total-count: 4
link: <op.digesto.com.br/companies?page=1&per_page=30>; rel="self"

Filtrar Empresas#

Além de listar todas as empresas vinculadas ao token, também é possível realizar filtragens com o parâmetro where.

Por exemplo, para filtrar por uma empresa com ID 88:

curl --request GET \
     --url 'https://op.digesto.com.br/api/prazos_judiciais/companies?where={"id": 88}' \
     --header 'Authorization: Bearer <token>'

Resposta correspondente:

[
    {
        "id": 88,
        "name": "Company Procon Teste 1 Ltda.",
        "cnpj": "35175769000125",
        "description": "Company para teste 1 no jus-solucoes-op-api",
        "dg_created_at": "2025-07-16T14:14:07.804783"
    }
]