Ferndesk

Articles

Créer un article

Crée un nouvel article du centre d'aide et le publie immédiatement. Vous pouvez éventuellement l'assigner à une collection, définir des métadonnées SEO et fournir un slug personnalisé.

Limite de débit : 60 requêtes par heure par clé API.

POST /articles

Créer un article

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "title": "<string>",
  "contentHtml": "<string>",
  "url": "<url>",
  "sectionId": "<string>",
  "collectionId": "<string>",
  "status": "<string>",
  "publishedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Article créé

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un jeton Bearer dans l'en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page des Paramètres développeur.

Request Body

application/json
  • title string requis

    Titre de l'article.

  • subtitle string | null

    Sous-titre optionnel de l'article.

  • content any

    Charge utile du contenu de l'article. Si omis, un corps de brouillon vide est utilisé.

  • sectionId string requis

    ID de la section où l'article doit être créé.

  • collectionId string | null

    ID de collection optionnel pour grouper cet article.

  • keywords string

    Mots-clés SEO.

  • metaDescription string

    Méta-description SEO.

  • ogImage string

    URL de l'image Open Graph.

  • slug string

    Slug d'URL personnalisé. Fournir un nouveau slug active automatiquement le mode slug personnalisé.

Response

application/json
  • id string

    ID d'article Ferndesk (art_...).

  • title string

    Titre principal de l'article.

  • contentHtml string

    Contenu de l'article rendu en HTML.

  • url string (uri) | null

    URL publique canonique pour cet article.

  • sectionId string | null

    ID de la section contenant l'article.

  • collectionId string | null

    ID de regroupement de collection optionnel pour l'article.

  • status string | null

    Statut de publication de l'article.

  • publishedAt string | null

    Horodatage de la publication de l'article.

  • createdAt string

    Horodatage ISO 8601 en UTC.

  • updatedAt string

    Horodatage ISO 8601 en UTC.