Piloterr

Python

Installieren Sie das Python-SDK von Piloterr und starten Sie Ihren ersten API-Aufruf.

Das offizielle Python-SDK von Piloterr mit einer typisierten Methode pro Endpunkt und einem generischen request() für alles andere.

Voraussetzungen

  • Python 3.11+

Installation

pip install piloterr

API-Schlüssel erhalten

Kopieren Sie Ihren API-Schlüssel aus dem Piloterr-Dashboard und legen Sie ihn in der Umgebungsvariable PILOTERR_API_KEY ab, die das SDK standardmäßig liest. Checken Sie ihn nicht in die Versionsverwaltung ein.

Schnellstart

import os

from piloterr import PiloterrClient

with PiloterrClient(os.environ["PILOTERR_API_KEY"]) as client:
    response = client.amazon_product(query="B09DFCB66S")
    print(response.data)

Asynchrone Jobs

Jeder Aufruf akzeptiert is_async, nützlich jenseits des Serverlimits von 60 Sekunden. Die Antwort ist dann eine job_id, und das SDK kann auf das Ende des Jobs warten.

submitted = client.amazon_product(query="B09DFCB66S", is_async=True)
job = client.wait_for_job(
    submitted.data["job_id"],
    on_progress=lambda j: print(j["status"], j.get("progress")),
)
print(job.data)

Fehler

Eine Antwort außerhalb von 2xx löst einen API-Fehler mit Status und Meldung aus. Die vollständige Liste finden Sie unter Statuscodes.

from piloterr import PiloterrAPIError

try:
    client.amazon_product(query="B09DFCB66S")
except PiloterrAPIError as error:
    print(error.status, error, error.response_body)

Wiederholungen

Anfragen werden bis zu 3-mal wiederholt nach einem Netzwerkfehler, einem 408, 500, 502, 503 oder 504 oder einem Ratenlimit des Tarifs. Kontingentfehler pro Schlüssel und clientseitige Timeouts werden nicht wiederholt. Die Wartezeit beginnt bei 1 Sekunde und wächst pro Wiederholung um das 1,5-Fache; ein Retry-After-Header hat Vorrang.

client = PiloterrClient(max_retries=5, retry_delay=0.5)

# or for one request
client.amazon_product(query="B09DFCB66S", request_options=RequestOptions(max_retries=0))

Batch-Anfragen

Führen Sie viele Aufrufe gleichzeitig aus, standardmäßig 10. Ein Fehler stoppt die anderen nicht.

inputs = ["B09DFCB66S", "B0BSHF7WHW", "B08N5WRWNW"]
results = client.batch(inputs, lambda query: client.amazon_product(query=query), concurrency=5)

for result in results:
    if result.ok:
        print(result.value.data)
    else:
        print(inputs[result.index], result.error)

Beliebiger Endpunkt

request() erreicht jeden Pfad, auch Endpunkte, die nach Ihrer SDK-Version erschienen sind.

response = client.request("GET", "/v1/usage")

Häufige Fehler

  • Den API-Schlüssel in Frontend-Code einbauen. Jeder könnte ihn lesen. Rufen Sie die API von Ihrem Server auf.
  • Jeden 401 als falschen Schlüssel behandeln. Ein 401 kann auch ein Ratenlimit sein: Lesen Sie die Meldung. Das SDK wiederholt Tarif-Ratenlimits automatisch.
  • Einen 402 wiederholen. Es sind keine Credits oder Kontingente mehr übrig, eine Wiederholung kann also nicht gelingen. Siehe Credits.
  • Auf lange Anfragen warten. Nutzen Sie ab 60 Sekunden den asynchronen Modus wie oben gezeigt, statt das Timeout zu erhöhen. Siehe Timeout.

Auf dieser Seite