POST
/
catalog
/
secao
Gerar Seções Embedáveis
curl --request POST \
  --url https://kong.api.toolzz.com.br/catalog/secao \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "school": "<string>",
  "content_type": [
    {}
  ],
  "groups": [
    {}
  ],
  "subgroups": [
    {}
  ],
  "specialties": [
    {}
  ],
  "order": [
    {}
  ],
  "criteria": 123,
  "orientation": 123,
  "status": 123,
  "content_attributes": 123,
  "manual": [
    {}
  ]
}'

​
Parâmetros

​
name
string
required
Nome da nova seção a ser criada.
​
description
string
Descrição da seção.
​
school
string
Identificador único da escola, permitindo a criação de seções exclusivas para cada unidade.
​
content_type
array
required
Array obrigatório que define os tipos de conteúdo a serem incluídos na seção.
​
groups
array
Array opcional contendo strings ou IDs dos grupos existentes. Os nomes ou IDs devem corresponder exatamente aos grupos já cadastrados.
​
subgroups
array
Array opcional contendo strings ou IDs dos subgrupos. Os nomes ou IDs devem corresponder exatamente aos subgrupos existentes e relacionados aos grupos.
​
specialties
array
Array opcional contendo strings ou IDs das especialidades. Os nomes ou IDs devem corresponder às especialidades existentes e relacionadas aos subgrupos.
​
order
array
Array contendo objetos com as propriedades criteria e orientation para definir a ordenação dos itens na seção.
​
criteria
int
alphabetical = 1 | creation_date = 2 | price = 3 | random = 4
​
orientation
int
crescent = 1 | decrescent = 2
​
status
int
required
active = 1 | inactive = 2
​
content_attributes
int
1 = Popularidade (os mais acessados)
2 = Avaliações (os mais bem avaliados)
3 = Novidades (os criados mais recentemente)
4 = Manual (IDs específicos)
​
manual
array
Se content_attributes for 4, deve ser incluído um array “manual” com os IDs dos itens desejados (máximo de 10 itens).
Para utilizar este recurso, é necessário possuir a feature “Provas Classificatórias” ativa na plataforma.
Antes de utilizar este endpoint, certifique-se de possuir o seguinte parâmetro disponível:

​
Detalhes dos parâmetros de requisição:

  • Token de acesso obrigatório: Certifique-se de possuir um token de autenticação válido antes de prosseguir.
  • name obrigatório: Nome da nova seção.
  • description: Descrição da seção.
  • school: Identificador da escola para criação de seções exclusivas da unidade.
  • content_type obrigatório: Array indicando os tipos de conteúdos. Opções:
    • courses = 1
    • components = 2
    • trail = 3
    • learning_object = 4
    • video = 5
    • audio = 6
    • album = 7
    • pdf = 8
    • text = 9
    • package = 10
  • groups: Array de strings ou IDs, representando os grupos associados.
  • subgroups: Array de strings ou IDs, representando os subgrupos associados.
  • specialties: Array de strings ou IDs, representando as especialidades associadas.
  • order: Array de objetos para definir a ordenação dos itens na seção, com dois campos:
    • criteria: Inteiro para o critério de ordenação. Opções:
      • alphabetical = 1 (padrão)
      • creation_date = 2
      • price = 3
      • random = 4
    • orientation: Inteiro para a orientação da ordenação. Opções:
      • crescent = 1
      • decrescent = 2
  • status obrigatório: Inteiro para definir o status da seção. Opções:
    • active = 1
    • inactive = 2
  • content_attributes: Inteiro para definir o critério de seleção de itens para a seção:
    • 1: Popularidade (os mais acessados)
    • 2: Avaliações (os mais bem avaliados)
    • 3: Novidades (os mais recentes)
    • 4: Manual (IDs específicos)
      • Se content_attributes for 4, incluir o objeto manual com um array de IDs (máximo de 10 itens).