Vous pouvez utiliser vos lectures FeedBro dans d’autres applications et outils de deux façons. Les liens RSS transforment vos articles enregistrés, ou une collection, en un flux que n’importe quelle application RSS ou outil d’automatisation peut lire, sans aucune configuration. L’API pour développeurs permet à vos propres scripts et applications de lire vos flux et vos articles et, avec le Coffee Club, de les marquer comme lus ou enregistrés.
Vos lectures sous forme de liens RSS
Un flux RSS est une liste des articles les plus récents que des applications peuvent consulter pour repérer les nouveautés. FeedBro vous donne des liens RSS privés pour vos propres listes :
- Enregistrés : les articles que vous avez enregistrés dans FeedBro. Toutes les offres ont ce lien.
- Un lien par collection, avec les articles les plus récents de tous les flux de cette collection. Cela fait partie du Coffee Club.
Vous pouvez les utiliser pour envoyer vos articles enregistrés vers une autre application de lecture, un service de lecture différée, une messagerie d’équipe ou un outil d’automatisation qui comprend le RSS.
Copier vos liens RSS
- Connectez-vous sur feedbro.com et ouvrez Paramètres (depuis le menu sous votre photo de profil).
- Cliquez sur l’onglet Flux.
- Repérez la carte Vos lectures en RSS.
- À côté de Enregistrés (et, avec le Coffee Club, à côté du nom de chaque collection), cliquez sur Copier. Le bouton affiche Copié un instant. Vous pouvez aussi cliquer dans le champ pour sélectionner le lien.
- Collez le lien dans votre autre application, là où elle demande l’adresse d’un flux.
Avec l’offre Free, vos collections sont listées avec un cadenas et la mention « Les liens de collection font partie de Coffee Club. » Avec le Coffee Club, si vous n’avez pas encore de collection, la carte indique « Créez une collection pour obtenir aussi un lien RSS. »
Ce que contient chaque élément
- Le titre de l’article et un lien vers l’article d’origine sur le site de l’éditeur.
- Le court résumé publié par le flux lui-même (jusqu’à environ 600 caractères), quand il y en a un.
- La date de publication.
Le texte complet de l’article récupéré par FeedBro n’est pas inclus. Votre autre application ouvre la page d’origine quand vous cliquez sur un élément.
Les limites de chaque offre
Avec l’offre Free, vous n’avez que le lien des enregistrés, avec vos 20 derniers articles enregistrés. Il se met à jour au plus toutes les 15 minutes.
Avec le Coffee Club, vous avez le lien des enregistrés et un lien pour chaque collection, avec 50 articles chacun. Ils se mettent à jour au plus toutes les 5 minutes.
Si vous quittez le Coffee Club, vos liens de collection s’ouvrent toujours, mais une application RSS n’affiche qu’un seul élément qui indique « Les liens de collection font partie de Coffee Club. »
Garder les liens privés
Les liens contiennent un code secret et fonctionnent sans connexion, pour que d’autres applications puissent les lire. Cela signifie aussi que toute personne qui possède un lien peut lire cette liste : gardez-les pour vous.
Si un lien a été partagé par erreur :
- Ouvrez Paramètres, puis l’onglet Flux.
- Dans Vos lectures en RSS, cliquez sur Réinitialiser les liens.
- Vous voyez « Vos anciens liens RSS ne fonctionnent plus. Les nouveaux sont ci-dessous. » Copiez les nouveaux liens dans les applications que vous voulez continuer à utiliser.
La réinitialisation désactive tous les anciens liens d’un coup : le lien des enregistrés et tous les liens de collection.
L’API pour développeurs
Une API permet à des programmes de communiquer directement avec FeedBro. Avec une clé API personnelle (un long code secret qui sert de mot de passe pour un programme), un script ou une application peut lire vos flux, vos collections, vos articles et vos pages enregistrées au format JSON (un format texte simple que lisent les programmes). Elle utilise votre propre compte : ce qu’elle modifie apparaît dans FeedBro, et inversement.
Les limites de chaque offre
Avec l’offre Free, vous avez 1 clé et 500 requêtes par mois, jusqu’à 30 requêtes par minute et par clé, en lecture seule.
Avec le Coffee Club, vous avez jusqu’à 5 clés et 100 requêtes par jour, jusqu’à 60 requêtes par minute et par clé. Les clés peuvent aussi marquer des articles comme lus, enregistrés ou à lire plus tard. Elles peuvent lancer des tâches en arrière-plan (comme récupérer le texte complet d’un article ou extraire le texte principal de n’importe quelle page web) et envoyer les résultats à un webhook (une adresse sur votre propre serveur que FeedBro appelle quand quelque chose est prêt).
Le compteur mensuel de l’offre Free repart le 1er de chaque mois, et le compteur quotidien du Coffee Club à minuit UTC. La plupart des requêtes comptent pour 1. Les tâches en arrière-plan comptent davantage parce qu’elles font plus de travail : récupérer un article ou extraire une page compte pour 10, suivre un flux pour 5, lancer une surveillance de site pour 25. Si une tâche échoue, elle compte pour 1 et le reste vous est rendu.
Créer une clé API
- Ouvrez Paramètres et cliquez sur l’onglet API.
- Dans la carte Accès API, tapez un nom pour la clé dans le champ (par exemple « Mon script »), pour pouvoir distinguer vos clés plus tard.
- Cliquez sur Créer une clé.
- La clé apparaît avec le message « Copiez cette clé maintenant. Elle n’est affichée qu’une fois. » Cliquez sur Copier et rangez la clé en lieu sûr, par exemple dans un gestionnaire de mots de passe.
Vos clés sont listées dans la même carte avec leur nom et leur dernière utilisation (« Jamais utilisé » jusqu’à la première requête). Pour désactiver une clé, cliquez sur Révoquer à côté et confirmez. Si vous perdez une clé, révoquez-la et créez-en une nouvelle.
Voir votre consommation
La carte Utilisation en haut de l’onglet API affiche par exemple « 12 sur 500 requêtes ce mois-ci », combien il en reste, la date de remise à zéro du compteur et le nombre de requêtes par minute que chaque clé peut envoyer. Le graphique 30 derniers jours montre vos requêtes par jour. Sous les clés, Tâches récentes en arrière-plan liste les tâches lancées par vos clés, avec leur statut (En attente, En cours, Terminé ou Échec), leur durée et ce qu’elles ont compté.
La documentation de l’API et le bac à sable
La documentation complète se trouve sur la page API FeedBro. Vous y accédez par le lien documentation de l’API dans les paramètres, ou par API développeurs en bas de chaque page. Elle couvre chaque requête, avec des exemples de réponses et tous les messages d’erreur.
La page comporte un bac à sable appelé Try it (essayer), où vous pouvez tester des requêtes sans écrire de code :
- Collez votre clé dans le champ API key (clé API). Elle est masquée pendant la saisie ; le bouton en forme d’œil l’affiche.
- Choisissez une requête dans la liste Call (appel), par exemple GET /summary/unread-count. La ligne en dessous indique ce qu’elle fait, si elle demande le Coffee Club et ce qu’elle compte.
- Remplissez les champs affichés. Les champs marqués d’un * sont obligatoires.
- Cliquez sur Send (envoyer). La réponse apparaît en dessous, avec son statut et le nombre de requêtes qu’il vous reste.
- Cliquez sur Copy as curl (copier en curl) pour copier la même requête sous forme de commande à lancer dans un terminal.
Les requêtes du bac à sable sont réelles : elles utilisent votre compte et comptent dans votre offre. Votre clé n’est enregistrée nulle part et reste dans le champ seulement jusqu’à ce que vous quittiez la page. Si vous utilisez Postman (un outil répandu pour tester des API), la page propose aussi Download the Postman collection (télécharger la collection Postman).
Un premier exemple en termes simples
Chaque requête va vers une adresse qui commence par https://feedbro.com/api/v1 et transporte votre clé dans un en-tête appelé Authorization, sous la forme Bearer suivi d’une espace et de votre clé. Par exemple, un programme qui demande GET /summary/unread-count reçoit un seul nombre, le nombre d’articles non lus dans l’ensemble de vos flux, avec l’heure à laquelle il a été calculé. Un programme qui demande GET /articles avec filter=unread reçoit vos articles non lus, 25 à la fois, du plus récent au plus ancien. Chacun arrive avec son titre, son lien, son résumé, son image et l’indication qu’il est lu, enregistré ou dans À lire plus tard.
Lire un article avec une clé ne le marque pas comme lu dans FeedBro. L’API ne fait jamais non plus attendre votre programme pendant la récupération d’un site. Elle répond avec ce que FeedBro possède déjà, et tout ce qui demande une récupération passe par une tâche en arrière-plan.
Bon à savoir
- Traitez une clé API comme un mot de passe, car toute personne qui la possède peut lire votre compte. Ne la collez jamais sur une page publique et ne la montrez pas dans une capture d’écran.
- Si une application ne comprend que le RSS, vous n’avez pas besoin de clé. Utilisez plutôt vos liens RSS.
- Vos liens RSS et vos clés API sont indépendants. Réinitialiser vos liens RSS n’a aucun effet sur vos clés, et révoquer une clé n’a aucun effet sur vos liens.
Si quelque chose ne fonctionne pas
« Unauthenticated. »
La clé manque, est mal saisie ou a été révoquée. Vérifiez l’en-tête Authorization, ou créez une nouvelle clé.
« On the Free plan an API key can read only. » ou « Background jobs and webhooks are part of Coffee Club. »
La requête nécessite le Coffee Club.
« Too many requests this minute. Wait a moment and try again. »
Votre programme envoie des requêtes trop vite. Attendez le nombre de secondes indiqué dans la réponse, puis réessayez.
« Monthly limit reached » (offre Free) ou la limite quotidienne (Coffee Club)
Vos requêtes sont épuisées jusqu’à la date de remise à zéro indiquée dans la réponse et sur la carte Utilisation.
« L’offre gratuite comprend 1 clé API. Coffee Club en permet jusqu’à 5. » ou « Vous pouvez avoir jusqu’à 5 clés. Révoquez-en une d’abord. »
Révoquez une clé que vous n’utilisez plus avant d’en créer une nouvelle.
Mon application RSS ne se met plus à jour
Si vous avez cliqué sur Réinitialiser les liens, les anciens liens ne fonctionnent plus. Copiez les nouveaux depuis Paramètres, onglet Flux.
Le lien RSS de ma collection n’affiche qu’un élément sur le Coffee Club
Les liens de collection nécessitent le Coffee Club. Le lien des enregistrés fonctionne avec toutes les offres.
Mon article enregistré n’est pas encore dans l’application RSS
Les liens se mettent à jour au plus toutes les 15 minutes avec l’offre Free et toutes les 5 minutes avec le Coffee Club, et votre application RSS vérifie à son propre rythme. Patientez un peu et vérifiez à nouveau.
