Firmreader Docs Online logo

Python

Apprenez à installer et utiliser le SDK Python Firmreader pour créer des posts, répertorier le contenu des canaux et gérer les erreurs d’API avec Python 3.9+.

Le SDK Python cible Python 3.9 et versions ultérieures et expose un client synchrone. Un client asynchrone est disponible sous firmreader.aio.

Installer

pip install firmreader

Initialiser le client

import os
from firmreader import Firmreader

client = Firmreader(api_key=os.environ["FIRMREADER_API_KEY"])  # fr_live_...

Créer un post

post = client.posts.create(
    channel_id="ch_company_news",
    title="Welcome to Firmreader",
    body="We're excited to announce our new internal communications platform.",
    priority="normal",
)

print(f"Published post {post.id}")

Répertorier les posts

posts = client.posts.list(channel_id="ch_company_news", limit=20)

for post in posts.data:
    print(post.title)

Gérer les erreurs

Les réponses autres que 2xx lèvent FirmreaderError, qui contient le status HTTP et un code d’API.

from firmreader import FirmreaderError

try:
    client.posts.create(channel_id="ch_invalid", title="Hi", body="...")
except FirmreaderError as err:
    print(f"{err.status}: {err.code}")

Transmettez idempotency_key="..." à toute méthode d’écriture afin que les requêtes réessayées ne créent pas de posts en double.

Last updated on