Aller au contenu

Capzy Data API. Choisissez votre source.

Trouvez l’endpoint d’un site pris en charge, envoyez ses paramètres et recevez du JSON. Consultez la référence ici, puis exécutez et examinez les requêtes dans le playground de votre tableau de bord.

La recherche Amazon en un coup d’œil

Source + actionGET /v1/amazon/search
Requêtewireless earbuds
Champ de réponseorganic_results · titres, prix, ASIN

Exemple illustratif

Trouvez la source dont vous avez besoin

Chaque source possède ses propres endpoints, entrées requises et format de réponse. Ouvrez sa référence pour vérifier la couverture avant de développer une intégration.

Toutes les sources (83)

Votre première requête Data API

Cet exemple Amazon utilise un endpoint GET propre à la source. HTTP 200 renvoie les données de la source ; HTTP 202 renvoie un statut en attente et un jobId. Examinez les tâches en attente sur la page Exécutions du tableau de bord Data API avant d’envoyer une autre requête.

  1. Créez une clé Data API

    Ouvrez le tableau de bord Data API pour copier votre clé Data API dédiée. Les crédits du forfait sont utilisés en premier ; l’utilisation supplémentaire est prélevée sur le solde partagé de votre compte Capzy.

    Ouvrir la Data API
  2. Choisissez la source et l’action

    Utilisez la référence du site pour trouver la méthode, le chemin et les paramètres requis. L’exemple de recherche Amazon envoie query et domain à /v1/amazon/search.

    Lire les paramètres de la recherche Amazon
  3. Examinez le JSON dans le playground

    Ouvrez la source correspondante dans votre tableau de bord, sélectionnez l’action, renseignez ses entrées et exécutez une requête. Vérifiez le prix actuel de l’endpoint avant l’exécution.

    Ouvrir le playground de recherche Amazon
amazon_search.py
# Install: pip install requests
import os
import requests

response = requests.get(
    "https://api.capzy.ai/v1/amazon/search",
    headers={"X-API-Key": os.environ["CAPZY_DATA_API_KEY"]},
    params={"query": "wireless earbuds", "domain": "com"},
    timeout=120,
)
response.raise_for_status()
data = response.json()
if response.status_code == 202:
    print("Pending:", data.get("status"), "Job:", data.get("jobId"))
    print("Inspect this job in https://capzy.ai/dashboard/data-api/runs")
else:
    for item in data.get("organic_results", []):
        print(item["title"], item.get("price"))
    print("Credits used:", response.headers.get("X-Credits-Used"))

Connaissez le contrat avant de l’appeler

L’authentification est commune à toutes les sources de la Data API. Les méthodes, paramètres et champs renvoyés sont propres à chaque endpoint.

X-API-KeyRequis · en-tête
Envoyez votre clé Data API dédiée dans cet en-tête. Gardez-la côté serveur et lisez-la depuis CAPZY_DATA_API_KEY dans ces exemples.
/v1/{source}/{path}Propre à l’endpoint · chemin
Suivez la méthode et le chemin indiqués dans la référence de la source. Par exemple, GET /v1/amazon/search prend query et domain comme paramètres de requête.
X-Credits-UsedEn-tête de réponse
Consultez les crédits facturés pour la requête. Les prix des endpoints et les remises des forfaits sont indiqués dans le tableau de bord et la référence de la source.
X-Next-CursorEn-tête de réponse · si présent
Certains endpoints renvoient un curseur pour la page suivante. Utilisez les paramètres de pagination de chaque endpoint ; toutes les sources n’utilisent pas le même modèle de pagination.

Utilisez les vrais champs de réponse de la source

Une réponse HTTP 200 de la recherche Amazon expose organic_results au premier niveau. HTTP 202 renvoie plutôt une enveloppe de statut avec un jobId ; examinez-la sur la page Exécutions du tableau de bord. Cette réponse réussie abrégée utilise des données produit illustratives.

response.example.json
{
  "search_information": {
    "query": "wireless earbuds"
  },
  "organic_results": [
    {
      "title": "Example wireless earbuds",
      "price": "$27.99",
      "extracted_price": 27.99,
      "asin": "EXAMPLE001"
    }
  ]
}

organic_results · titres, prix, ASIN

Paramètres

Tarifs

Les forfaits Data API incluent un quota mensuel de crédits. L’utilisation supplémentaire est prélevée sur le solde partagé de votre compte Capzy. Consultez la référence de la source pour connaître le prix actuel en crédits de l’endpoint.

Chargement des prix actuels…

Quelques points à connaître

Où s’ouvre le playground ?

Dans Tableau de bord → Data API → Scrapers. Les liens de source ouvrent le configurateur de cette source. Les liens d’endpoint présélectionnent l’action correspondante, pour que vous puissiez examiner les entrées requises avant l’exécution.

Puis-je utiliser ma clé API de solveur ?

Utilisez la clé Data API dédiée affichée dans le tableau de bord Data API. La Data API a ses propres contrôles de forfait et crédits inclus, tandis que l’utilisation supplémentaire est financée par le solde partagé de votre compte Capzy.

Toutes les sources renvoient-elles le même JSON ?

Non. Chaque endpoint a un format de réponse propre à sa source. Examinez la réponse documentée et gérez les champs manquants ou facultatifs dans votre application.

Et si un endpoint est indiqué « bientôt disponible » ?

Le tableau de bord signale les endpoints qui ne sont pas vérifiés ou pas encore exécutables. Utilisez les actions prises en charge qui y sont indiquées ; une entrée dans la référence ne garantit pas à elle seule qu’un endpoint est prêt.

Trouvez une source. Testez une vraie requête.

Le playground du tableau de bord réunit les entrées, la réponse et les tarifs actuels.

Ouvrir le playground