Firmreader Docs Online logo

Python

Aprende a instalar y usar el SDK de Python de Firmreader para crear publicaciones, listar contenido de canales y gestionar errores de API en Python 3.9+.

El SDK de Python está diseñado para Python 3.9+ y proporciona un cliente síncrono. Hay un cliente asíncrono disponible en firmreader.aio.

Instalar

pip install firmreader

Inicializar el cliente

import os
from firmreader import Firmreader

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

Crear una publicación

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}")

Enumerar publicaciones

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

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

Gestionar errores

Las respuestas que no sean 2xx generan un FirmreaderError, que contiene el status HTTP y un code de 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}")

Pasa idempotency_key="..." a cualquier método de escritura para que las solicitudes reintentadas no creen publicaciones duplicadas.

Last updated on