Empresas na API#

Esta API permite o cadastro de novas empresas usuárias pelo portal web ou via API.

Nota

É possível listar as empresas filhas da empresa em que o usuário atualmente logado se encontra fazendo uma chamada API GET op.digesto.com.br/api/admin/user_company.

Criando novas empresas (user_company)#

Ao criar uma nova empresa dentro da API, ela será uma empresa filha da empresa à qual o usuário que fez a criação pertence.

curl -X POST 'https://op.digesto.com.br/api/admin/user_company'

Logo após criar a Empresa-Filha, você pode fazer uma chamada para gerar o token do administrador. Nesse caso, as duas chamadas (para criar a empresa e para pegar o token do admin inicial da Empresa-Filha) são realizadas usando o token de API da Empresa-mãe.

Um usuário só enxerga as entidades/recursos da empresa dele. Ele também só pode criar entidades que nascem associadas à empresa dele. O máximo que um usuário administrador pode fazer é criar uma nova empresa filha e recuperar um token de API para administrar os recursos dela.

O fluxo resumido para provisionamento de novos clientes seria então:

  1. Criar nova Empresa-Filha, usando o token de um administrador da Empresa-mãe (chamada abaixo)

  2. Com o token de um administrador da Empresa-mãe, fazer uma chamada para gerar o token do administrador da Empresa-Filha recém-criada

  3. Com o token do administrador da Empresa-Filha, criar as partes monitoradas, processos etc.

  4. Caso a integração seja via webhooks (nossa API faz chamadas para o sistema do cliente com novos eventos), é necessário fazer login com o e-mail do administrador da nova Empresa-Filha. Verifique em Webhooks para configurar o endereço HTTP para onde enviaremos os eventos de monitoramento. Cada user_company tem seu endereço de webhook próprio.

Os usuários da empresa-mãe não enxergam as entidades (partes monitoradas, processos monitorados, usuários etc) da empresa filha.

Toda chamada feita com um API token de um usuário se refere à empresa deste usuário. Por exemplo, entidades criadas com o token de um usuário da empresa filha, ficarão na empresa filha. Esta hierarquia é ilustrada na figura abaixo.

../_images/hierarquia_user_company.png

Hierarquia entre empresas e suas entidades.#

cURL

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

Parâmetro

Tipo

Descrição

name

string

Nome da nova empresa.

Resposta

{
    "$uri": "/api/admin/user_company/7",
    "api_name": null,
    "created_at": {
        "$date": 1463940701000
    },
    "enabled_modules": "[]",
    "is_archived": false,
    "logo_url": null,
    "name": "Nova empresa",
    "trib_monitor_config": "{}",
    "user_company": {
        "$ref": "/api/admin/user_company/1"
    },
    "users": []
}

Parâmetro

Tipo

Descrição

$uri

string

URI da nova empresa criada.

api_name

string

Nome da empresa na API.

created_at

datetime

Data e hora da criação.

enabled_modules

string

Módulos habilitados.

is_archived

boolean

Se a empresa foi arquivada.

logo_url

string

URL do logo da empresa.

name

string

Nome da empresa.

trib_monitor_config

string

Configuração de monitoramento de tribunais.

user_company

object

Referência à empresa mãe.

users

array

Lista de usuários da empresa.

  • Note que na resposta, 7 é o id da user_company filha recem-criada e 1 da user_company mãe.

Criando manualmente nova empresa#

Todas as operações abaixo estão disponíveis via API (seções anteriores), para execução autônoma pelo software cliente e o servidor de API Digesto.

No entanto, para facilitar a criação de novas empresas (user_company ) e cadastrar as partes monitoradas (monitored_person ) associadas a esta empresa, disponibilizamos uma interface web. Veja os passos:

  1. Fazer login na empresa mãe;

  2. No menu à esquerda, ir em Configuracoes > Empresas;

  3. Criar a nova empresa (filha), escolhendo um novo e-mail para o campo E-mail de um novo administrador. Este e-mail deve ser diferente de qualquer outro usuário do sistema.;

  4. Fazer logout da conta na empresa mãe;

  5. Fazer login na empresa filha com o e-mail do novo administrador;

  6. Cadastrar as partes monitoradas em massa (menu à esquerda Partes > Monitorar em massa) ou cadastrar um a um em Partes > Partes monitoradas > Nova;

  7. Obter o token de integração na API, indo em Configurações > Integração via API. O token fica na caixa Autenticação (enviar dados para API). Este token é usado para autenticar o software cliente que faz as chamadas para a API. Usando este token, a API saberá que se trata de dados e alertas da nova empresa-filha.