Buscar artículos | Referencia de la API | Centro de ayuda

{ "items": [ { "id": "<string>", "title": "<string>", "contentHtml": "<string>", "url": "<url>", "sectionId": "<string>", "collectionId": "<string>", "status": "<string>", "publishedAt": "<string>", "createdAt": "<string>", "updatedAt": "<string>" } ], "limit": 1, "offset": 1, "total": 1 }

Authorizations

Authorization string obligatorio header

Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse en secreto. Puede generar y administrar claves desde la página de Configuración de desarrolladores.

Query Parameters

limit integer

Número máximo de resultados de búsqueda a devolver. Ejemplo: 20
offset integer

Número de resultados clasificados a omitir. Ejemplo: 0
query string obligatorio

Consulta de búsqueda de texto libre. Ejemplo: authentication

Response

application/json

items[] object array

Elementos de la página actual. Carga útil del artículo devuelta por los puntos finales de artículos.
+ - Show Child Attributes
- id string
  
  ID de artículo de Ferndesk (art_...).
- title string
  
  Título principal del artículo.
- contentHtml string
  
  Contenido del artículo renderizado como HTML.
- url string (uri) | null
  
  URL pública canónica para este artículo.
- sectionId string | null
  
  ID de la sección que contiene el artículo.
- collectionId string | null
  
  ID opcional de la colección que agrupa el artículo.
- status string | null
  
  Estado de publicación del artículo.
- publishedAt string | null
  
  Marca de tiempo de cuando se publicó el artículo.
- createdAt string
  
  Marca de tiempo ISO 8601 en UTC.
- updatedAt string
  
  Marca de tiempo ISO 8601 en UTC.
limit integer

Tamaño de página utilizado para esta respuesta.
offset integer

Número de registros omitidos para esta página.
total integer

Total de registros coincidentes en todas las páginas.