API: Como obter informações de conteúdos
Atualizado
por
Larson Guimarães
Como obter informações de conteúdos
A API do Learning.Rocks dispõe de endpoints para obter informações dos conteúdos. Clicando aqui você pode acessar a collection completa de contents.
Informações que podem ser obtidas:
- ID;
- ID Externo;
- Titulo;
- Descrição;
- Tipo;
- Carga horária;
- Espaço onde o conteúdo está alocado;
- Seção do espaço;
- ID do autor;
- Certificado habilitado;
- Atividade atrelada;
- Feedback atrelado;
- Data de criação;
- Data da última atualização;
Busca por conteúdo via ID
Para buscar o conteúdo a partir do ID, é necessário enviar o comando GET para a URL: https://content.skore.ai/api/v1/contents/id O campo “id” deve ser substituído pelo id do conteúdo.
Parâmetros
- ID: É um parâmetro obrigatório na busca. Pode ser preenchido com o ID ou ID externo do conteúdo.
Exemplo de request e response:
Busca por conteúdo usando filtros
Para buscar o conteúdo a partir do ID, é necessário enviar o comando GET para a URL: https://content.skore.ai/api/v1/contents?date_type=CREATED_AT&date_min=1700000000000&date_max=1700040000000&sort_by=CREATED_AT&sort_order=DESC&skip=0&take=10. Os campos sinalizados devem ser substituídos pelas respectivas informações.
Parâmetros
- date_type (string, obrigatório se min ou max for fornecido): Tipo de campo de data para filtrar. Aceita CREATED_AT para filtrar por data de criação ou UPDATED_AT para filtrar por data da última atualização.
- date_min (número, opcional): Filtro de intervalo de datas usando timestamps Unix em milissegundos. Esse parâmetro define a data mínima para filtrar o conteúdo dentro do período especificado.
- date_max (número, opcional): Filtro de intervalo de datas usando timestamps Unix em milissegundos. Esse parâmetro define a data máxima para filtrar o conteúdo dentro do período especificado.
- skip (número, opcional): Parâmetro de paginação para controlar o número de registros retornados. Define o número de registros a serem ignorados (deslocamento).
- take (número, opcional): Parâmetro de paginação para controlar o número de registros retornados. Define o número máximo de registros a serem retornados (limite).
- sort_by (string, opcional): Campo pelo qual classificar os resultados. Aceita CREATED_AT para classificar por data de criação ou UPDATED_AT para classificar por data da última atualização.
- sort_order (string, opcional): Direção da ordem de classificação. Aceita ASC para ordem crescente ou DESC para ordem decrescente.
Pontos importantes
- Para lidar com um grande número de solicitações simultâneas, garantindo que o desempenho não seja comprometido, a resposta do serviço será paginada. Use os parâmetros skip e take para navegar pelos resultados. O campo total na resposta indica o número total de conteúdos que correspondem aos filtros antes da paginação.
- Ao especificar os parâmetros date_min e date_max para filtrar por intervalo de datas, também será obrigatório especificar o parâmetro date_type (CREATED_AT ou UPDATED_AT).
- Pelo menos um dos parâmetros date_min ou date_max deve ser fornecido quando date_type for especificado.
- O valor de date_min não pode ser maior ou igual ao valor de date_max do período.
- O valor de date_max deve ser estritamente maior que date_min quando ambos forem fornecidos.
- Quando sort_by e sort_order não forem informados, a ordenação padrão será do mais recente para o mais antigo.
- Os parâmetros skip e take devem ser números não negativos. Os valores padrão são skip = 0 e take = 10 se não forem especificados.
- O número máximo de registros (limite) por solicitação é 100.
Exemplo de request e response:
