Créer et utiliser votre clé API solvethree

Par solvethree3 min de lecture

Créez votre clé dans l’espace de travail que vous utiliserez pour la résolution. Conservez le secret complet sur votre serveur ; le préfixe de clé affiché ne suffit pas pour s’authentifier.

Sur cette page

Créez et enregistrez votre clé

  1. 1.

    Ouvrez Clés API

    Dans la console, ouvrez Clés API à l’adresse /api-keys dans l’espace de travail souhaité.

  2. 2.

    Nommez la clé

    Sélectionnez Créer une clé API. Dans Nom de la clé, saisissez un nom qui vous permettra de reconnaître où vous l’utiliserez, puis sélectionnez Créer la clé.

  3. 3.

    Copiez le secret complet

    Sous Enregistrez votre clé API, copiez le secret et conservez-le en lieu sûr pour votre application serveur. Il n’est affiché qu’une seule fois.

  4. 4.

    Fermez la boîte de dialogue

    Sélectionnez J’ai enregistré cette clé uniquement après avoir conservé le secret.

Envoyez la clé depuis votre serveur

Authentifiez les requêtes avec Authorization: Bearer suivi de la clé complète de l’espace de travail. Ne l’incluez pas dans le code côté navigateur.

Pour l’exemple ci-dessous, définissez SOLVETHREE_API_KEY sur votre secret et SOLVETHREE_PROXY sur l’URL de votre proxy dans l’environnement du serveur. Remplacez accounts.example.com et login par le nom d’hôte et l’action de votre cible. Le site cible doit déjà disposer d’un profil actif accessible à cet espace de travail ; envoyer son nom d’hôte n’en crée pas. Consultez la configuration des profils de site si vous ne l’avez pas encore configuré.

cURL + jq · créer une tâche
# Set SOLVETHREE_API_KEY and SOLVETHREE_PROXY in your environment first.
# Replace the hostname and action with your active site profile.
jq -n \
  --arg proxy "$SOLVETHREE_PROXY" \
  --arg requestId "login-$(date +%s)-$$" \
  '{site:"accounts.example.com", action:"login", proxy:$proxy, requestId:$requestId}' \
| curl --fail-with-body --max-time 30 \
  'https://api.solvethree.com/v1/tasks?waitMs=15000' \
  -H "Authorization: Bearer $SOLVETHREE_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-binary @-

Cela envoie une requête de création de tâche à l’API publique. Elle lance une véritable résolution, et pas seulement une vérification d’authentification : une tâche au statut ready est facturée. Une réponse HTTP réussie ne signifie pas à elle seule que la tâche est prête ni que le site cible acceptera sa solution.

Distinguez les erreurs d’authentification des erreurs de tâche

L’API renvoie HTTP 401.

Vérifiez l’en-tête Authorization envoyé par le serveur. Il doit contenir Bearer suivi du secret complet, et non du nom de la clé ou d’un préfixe affiché. Vérifiez si la clé a été révoquée.

Essayez ceci : Corrigez l’en-tête ou remplacez la clé révoquée et mettez à jour la configuration de votre serveur. Traitez la réponse HTTP d’échec avant d’essayer de lire les données d’une tâche.

La clé permet de s’authentifier, mais le profil de site souhaité n’est pas disponible.

Vérifiez à quel espace de travail appartient la clé et si cet espace dispose d’un profil actif pour le site cible. Une clé valide provenant d’un autre espace de travail n’est pas un identifiant global.

Essayez ceci : Utilisez une clé appartenant à l’espace de travail qui contient le profil souhaité, ou configurez le profil dans l’espace de travail que vous utilisez. Modifier le nom d’hôte dans la requête ne le créera pas.

Pour les autres échecs de requête ou de tâche, consultez les erreurs de l’API CAPTCHA.

Lancez votre première tâche.

Démarrez avec $5 de crédit dans votre espace de travail.

Créer un espace de travail
Créer et utiliser votre clé API solvethree · solvethree