יצירה ושימוש במפתח ה-API שלכם ב-solvethree

1. 1.

   פתיחת מפתחות API

   במסוף, פתחו את מפתחות API בנתיב /api-keys בסביבת העבודה המיועדת.

2. 2.

   מתן שם למפתח

   בחרו ביצירת מפתח API. בשדה שם המפתח הזינו שם שיעזור לכם לזהות היכן תשתמשו בו, ואז בחרו ביצירת מפתח.

3. 3.

   העתקת הסוד המלא

   תחת שמירת מפתח ה-API שלכם, העתיקו את הסוד ושמרו אותו באופן מאובטח עבור יישום השרת שלכם. הוא מוצג פעם אחת בלבד.

4. 4.

   סגירת תיבת הדו-שיח

   בחרו בשמרתי את המפתח הזה רק לאחר ששמרתם את הסוד.

אמתו בקשות באמצעות Authorization: Bearer ואחריו המפתח המלא של סביבת העבודה. אל תכללו אותו בקוד בצד הדפדפן.

בדוגמה הבאה, הגדירו בסביבת השרת את SOLVETHREE_API_KEY לסוד שלכם ואת SOLVETHREE_PROXY לכתובת ה-URL של הפרוקסי שלכם. החליפו את accounts.example.com ואת login בשם המארח ובפעולה של היעד שלכם. לאתר היעד כבר צריך להיות פרופיל פעיל שזמין לסביבת העבודה הזו; שליחת שם המארח שלו אינה יוצרת פרופיל. ראו הגדרת פרופיל אתר אם טרם הגדרתם אותו.

# 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 @-

פעולה זו שולחת בקשה ליצירת משימה ל-API הציבורי. היא יוצרת פתרון אמיתי, ולא רק בודקת אימות: משימה במצב ready מחויבת בתשלום. תגובת HTTP מוצלחת לבדה אינה מעידה שהמשימה מוכנה או שאתר היעד יקבל את הפתרון שלה.

ה-API מחזיר HTTP 401.

בדקו את כותרת Authorization שנשלחת מהשרת. היא צריכה להכיל Bearer ואחריו את הסוד המלא, ולא את שם המפתח או קידומת שנחשפה. בדקו אם המפתח בוטל.

כדאי לנסות: תקנו את הכותרת או החליפו את המפתח שבוטל ועדכנו את תצורת השרת שלכם. טפלו בתגובת ה-HTTP שאינה מציינת הצלחה לפני שתנסו לקרוא את נתוני המשימה.

האימות באמצעות המפתח מצליח, אך פרופיל האתר המיועד אינו זמין.

ודאו לאיזו סביבת עבודה שייך המפתח והאם יש בה פרופיל פעיל לאתר היעד. מפתח תקף מסביבת עבודה אחרת אינו אמצעי הזדהות גלובלי.

כדאי לנסות: השתמשו במפתח ששייך לסביבת העבודה עם הפרופיל המיועד, או הגדירו את הפרופיל בסביבת העבודה שבה אתם משתמשים. שינוי שם המארח בבקשה לא ייצור אותו.

לכשלים אחרים בבקשות ובמשימות, ראו שגיאות CAPTCHA API.