curl --request POST \
--url https://kinglog.app.br/companyProduct/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ana Lima",
"companyId": "UUID_DA_EMPRESA",
"userId": "UUID_DO_USUARIO"
}
'
{
"success": true,
"data": {},
"code": "SUCCESS"
}{
"success": false,
"status": 400,
"message": "Mensagem descritiva do erro",
"code": "CODIGO"
}{
"success": false,
"status": 401,
"message": "Não autorizado",
"code": "UNAUTHORIZED"
}{
"success": false,
"status": 403,
"message": "Sem permissão",
"code": "FORBIDDEN"
}{
"success": false,
"status": 404,
"message": "Não encontrado",
"code": "NOT_FOUND"
}Produto da entrega
Criar produto da empresa
Cadastra um produto da empresa.
POST
/
companyProduct
/
create
curl --request POST \
--url https://kinglog.app.br/companyProduct/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ana Lima",
"companyId": "UUID_DA_EMPRESA",
"userId": "UUID_DO_USUARIO"
}
'
{
"success": true,
"data": {},
"code": "SUCCESS"
}{
"success": false,
"status": 400,
"message": "Mensagem descritiva do erro",
"code": "CODIGO"
}{
"success": false,
"status": 401,
"message": "Não autorizado",
"code": "UNAUTHORIZED"
}{
"success": false,
"status": 403,
"message": "Sem permissão",
"code": "FORBIDDEN"
}{
"success": false,
"status": 404,
"message": "Não encontrado",
"code": "NOT_FOUND"
}Cadastra um produto da empresa.
Autenticação:
POST /companyProduct/create
Authorization: Bearer SEU_JWT.
| Campo | Valor |
|---|---|
| Identificador | products.create |
| Efeito | escrita |
| Domínio | Produtos |
Obrigatório
name, companyId, userId.Campos
| Campo | Onde | Tipo | Obrigatório | Detalhe |
|---|---|---|---|---|
description | corpo | string | não | Texto descritivo. |
clientIds | corpo | array | não | Opcional no corpo. |
relatedUserIds | corpo | array | não | Opcional no corpo. |
name | corpo | string | sim | Nome. |
companyId | corpo | string | sim | Empresa da sessão. |
userId | corpo | string | sim | Usuário da sessão. |
Exemplo mínimo
{
"name": "Ana Lima",
"companyId": "UUID_DA_EMPRESA",
"userId": "UUID_DO_USUARIO"
}
Exemplo completo
{
"description": "Detalhe da integração",
"clientIds": [],
"relatedUserIds": [],
"name": "Ana Lima",
"companyId": "UUID_DA_EMPRESA",
"userId": "UUID_DO_USUARIO"
}
Exemplo de resposta
{
"success": true,
"data": {},
"code": "SUCCESS"
}
companyId e userId são a empresa e o usuário do JWT, não um filtro opcional.Resposta
Sucesso:success é true, code é SUCCESS e o conteúdo vem em data. Falha de regra traz message, status e code. Falha de validação traz error. O índice está em Erros e códigos.
| Código | Quando | code |
|---|---|---|
200 | A operação concluiu | SUCCESS |
400 | Corpo ou combinação de campos recusada | CODIGO |
401 | JWT ausente, inválido ou chave kl_live_ revogada | UNAUTHORIZED |
403 | A pessoa, ou a chave restrita, não pode esse recurso | FORBIDDEN |
404 | Registro ou rota inexistente | NOT_FOUND |
Authorizations
Todas as requisições devem incluir o JWT da conta no header Authorization no formato Bearer. Sem esse header a requisição é recusada.
Body
application/json
Nome.
Example:
"Ana Lima"
Empresa da sessão.
Example:
"UUID_DA_EMPRESA"
Usuário da sessão.
Example:
"UUID_DO_USUARIO"
Texto descritivo.
Example:
"Detalhe da integração"
Opcional no corpo.
Example:
[]
Opcional no corpo.
Example:
[]