Criar contrato de SLA

curl --request POST \
  --url https://kinglog.app.br/service-agreement/{companyId}/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Ana Lima",
  "clientIds": [],
  "sem": "exemplo"
}
'

{
  "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"
}

POST

service-agreement

{companyId}

{userId}

curl --request POST \
  --url https://kinglog.app.br/service-agreement/{companyId}/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Ana Lima",
  "clientIds": [],
  "sem": "exemplo"
}
'

{
  "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"
}

Cria um contrato de serviço para um ou mais clientes.

POST /service-agreement/:companyId/:userId

Autenticação: Authorization: Bearer SEU_JWT.

Campo	Valor
Identificador	`sla.agreements.create`
Efeito	escrita
Domínio	SLA

Obrigatório

companyId, userId, name, clientIds, sem.

Campos

Campo	Onde	Tipo	Obrigatório	Detalhe
`companyId`	caminho	string	sim	Empresa da sessão.
`userId`	caminho	string	sim	Usuário da sessão.
`name`	corpo	string	sim	Nome.
`clientIds`	corpo	string	sim	com ao menos um uuid de cliente
`sem`	corpo	string	sim	repetir
`code`	corpo	string	não	Opcional no corpo.
`description`	corpo	string	não	Texto descritivo.
`status`	corpo	string	não	Opcional no corpo.
`autoRenewal`	corpo	string	não	Opcional no corpo.
`currency`	corpo	string	não	BRL, USD, EUR ou GBP.
`notes`	corpo	string	não	Observação.
`scopes`	corpo	string	não	PROJECT, HELPDESK ou ATTENDANCE
`businessHours`	corpo	string	não	Opcional no corpo.
`rules`	corpo	string	não	Opcional no corpo.

Exemplo mínimo

{
  "name": "Ana Lima",
  "clientIds": [],
  "sem": "exemplo"
}

Exemplo completo

{
  "name": "Ana Lima",
  "clientIds": [],
  "sem": "exemplo",
  "code": "exemplo",
  "description": "Detalhe da integração",
  "status": "exemplo",
  "autoRenewal": "exemplo",
  "currency": "BRL",
  "notes": "Detalhe da integração",
  "scopes": "exemplo",
  "businessHours": "exemplo",
  "rules": "exemplo"
}

Exemplo de resposta

{
  "success": true,
  "data": {},
  "code": "SUCCESS"
}

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

Authorization

string

header

required

Todas as requisições devem incluir o JWT da conta no header Authorization no formato Bearer. Sem esse header a requisição é recusada.

Path Parameters

companyId

string

required

Empresa da sessão.

Example:

"UUID_DA_EMPRESA"

userId

string

required

Usuário da sessão.

Example:

"UUID_DO_USUARIO"

Body

application/json

name

string

required

Nome.

Example:

"Ana Lima"

clientIds

string

required

com ao menos um uuid de cliente

Example:

[]

sem

string

required

repetir

Example:

"exemplo"

code

string

Opcional no corpo.

Example:

"exemplo"

description

string

Texto descritivo.

Example:

"Detalhe da integração"

status

string

Opcional no corpo.

Example:

"exemplo"

autoRenewal

string

Opcional no corpo.

Example:

"exemplo"

currency

string

BRL, USD, EUR ou GBP.

Example:

"BRL"

notes

string

Observação.

Example:

"Detalhe da integração"

scopes

string

PROJECT, HELPDESK ou ATTENDANCE

Example:

"exemplo"

businessHours

string

Opcional no corpo.

Example:

"exemplo"

rules

string

Opcional no corpo.

Example:

"exemplo"

Response

A operação concluiu. success é true, code é SUCCESS e o conteúdo vem em data.

success

boolean

required

Example:

true

data

any

required

Conteúdo da operação. O exemplo 200 de cada rota preenche os campos do recurso.

code

string

required

Example:

"SUCCESS"

Obrigatório

​Campos

​Exemplo mínimo

​Exemplo completo

​Exemplo de resposta

​Resposta

Authorizations

Path Parameters

Body

Response

Campos

Exemplo mínimo

Exemplo completo

Exemplo de resposta

Resposta