Référence de l'API des histoires Web

L'API Web Stories Data vous permet d'intégrer des fonctions qui sont normalement exécutées sur le site Web Web Stories Today dans votre propre site Web ou application. Les listes ci-dessous identifient les différents types de ressources que vous pouvez récupérer à l'aide de l'API, qui prend également en charge les méthodes d'insertion, de mise à jour ou de suppression d'un grand nombre de ces ressources.

1. Comment invoquer l'API
2. Types de ressources
   1. StoryCategory
   2. ChannelInfo
   3. WebStory

Ce guide de référence explique comment utiliser l'API pour effectuer toutes ces opérations.

Comment invoquer l'API

Chaque requête doit spécifier une clé API (avec le paramètre key). Votre clé API est disponible dans la Developer Console, accessible via votre tableau de bord.
La clé API est gratuite

Types de ressources

StoryCategory

Une ressource Storycategory contient des informations sur une catégorie particulière, y compris le nom d'affichage et la version encodée. A Storycategory resource contains information on a particuar category, including display name and the encoded version.

{
    "displayname": "Fashion for Her",
    "displayname_encoded": "fashion-for-here"
}

ChannelInfo

Une ressource ChannelInfo contient des informations sur une chaîne/un créateur particulier, y compris le nom d'affichage, l'URL, la description, le logo, le nombre d'histoires,...

{
    "name": "The Scotsman",
    "uid": "TheScotsman",
    "description": "Subscribe to The Scotsman for news, opinion and expert analysis from Scotland\u2019s national newspaper",
    "url": "https://webstories.today/@thescotsman",
    "logo": "https://webstories.today/images/channels/73d7af4b-6ee7-4c6d-b3c8-8ecc2ada095b-logo.jpg"
}
        

WebStory

Une ressource WebStory contient des informations sur une histoire particulière, y compris le nom d'affichage, l'URL, la description, les images, les informations sur la chaîne, la catégorie, etc.

 {
    "title": "Guide to puppy potty training",
    "url": "guide-to-potty-training-within-7-days",
    "language": "en",
    "description": "How to get your puppy potty trained quickly. The story contains easy and actionable steps. ",
    "channelinfo": {
    "name": "The Happy Puppers",
    "uid": "The-happy-puppers",
    "description": "Hi I\u0027m Dr. Shruti, and I love writing on everything related to dog care, so Welcome to your one-stop destination of dog care. Articles focus on dog care tips, grooming, psychology, training, diseases, and everything dog-related...",
    "url": "https://webstories.today/@the-happy-puppers",
    "logo": "https://webstories.today/images/channels/64790bff-a8d0-43be-b7a3-36a08bc0ff92-logo.jpg"
    },
    "category": {
    "displayname": "",
    "displayname_encoded": ""
}