Criando recursos#
Para criar qualquer recurso na API, envie uma solicitação HTTP POST para o endpoint correspondente. A entidade recém-criada é retornada, incluindo o identificador no campo $uri
. Para criar uma nova empresa, faça uma solicitação POST para o seguinte endpoint adicionando como corpo da requisição o nome da empresa.
Aviso
A user_company
de um recurso novo é inferida a partir da user_company
associada ao usuário autenticado. Não é possível especificar uma user_company diferente ao criar um recurso.
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 teste"
}'
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
string |
Nome da empresa, não pode ser vazio ou repetido. |
Resposta
{
"$uri": "/api/admin/user_company/1047697",
"api_name": "digesto",
"api_version": 5,
"archived_at": null,
"comment": null,
"config": {},
"created_at": {
"$date": 1725903400000
},
"email_config_id": 9056,
"enabled_modules": [],
"expires_at": null,
"is_trial": false,
"logo_url": null,
"name": "Nova empresa teste",
"protocolo_config": null,
"trial_days": 0,
"trib_monitor_config": {},
"url_monitor_config": {},
"user_company": {
"$ref": "/api/admin/user_company/4"
},
"user_company_id": 4,
"user_company_quota": {},
"user_company_quota_id": 5953,
"user_company_web": null,
"user_creator": {
"$ref": "/api/admin/user/11934"
},
"user_creator_id": 11934,
"users": []
}
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
string |
Nome da empresa, não pode ser vazio ou repetido. |
$uri |
string |
URI do recurso recém-criado. |
api_name |
string |
Nome da API. |
api_version |
integer |
Versão da API. |
archived_at |
datetime |
Data de arquivamento, se aplicável. |
comment |
string |
Comentário associado ao recurso. |
config |
object |
Configurações adicionais. |
created_at |
datetime |
Data de criação do recurso. |
email_config_id |
integer |
ID da configuração de email. |
enabled_modules |
array |
Módulos habilitados. |
expires_at |
datetime |
Data de expiração, se aplicável. |
is_trial |
boolean |
Indica se é um recurso de teste. |
logo_url |
string |
URL do logo associado. |
protocolo_config |
object |
Configuração de protocolo. |
trial_days |
integer |
Dias de teste. |
object |
Configuração de monitoramento de tribunais. |
|
object |
Configuração de monitoramento de URLs. |
|
object |
Empresa do usuário. |
|
user_company_id |
integer |
ID da empresa do usuário. |
user_company_quota |
object |
Quota da empresa do usuário. |
user_company_quota_id |
integer |
ID da quota da empresa do usuário. |
user_company_web |
string |
Web da empresa do usuário. |
object |
Criador do recurso. |
|
user_creator_id |
integer |
ID do criador do recurso. |
users |
array |
Lista de usuários associados. |