API לבדיקת גרסת TLS
ממשקי ה-API של מיקרופיי מקבלים חיבורי HTTPS בגרסת TLS 1.2 ומעלה בלבד. ממשק הבדיקה
(tlsCheck.php) מחזיר באיזו גרסת TLS הקוד שלך התחבר בפועל, כך שאפשר לוודא שהחיבור תקין
לפני שינוי, ואחרי תיקון. הבדיקה לא שולחת הודעות ולא מחויבת.
למה לבדוק?
ממשקי ה-API של מיקרופיי עובדים עם TLS 1.2 ומעלה בלבד. גרסאות TLS 1.0 ו-1.1 ישנות ואינן מאובטחות, וחיבורים בגרסאות אלה נדחים. קוד ישן עלול להשתמש בגרסה ישנה בלי שתדע: למשל פרויקט .NET Framework ישן, שמתחבר כברירת מחדל ב-TLS 1.0 גם כשהשרת תומך ב-TLS 1.2.
כתובת הממשק ושיטת השליחה
https://www.micropay.co.il/extApi/tlsCheck.php
יש לשלוח את כל שמות הפרמטרים באותיות קטנות (Lower Case). ניתן להעביר את הפרמטרים בשיטת GET או POST, או לשלוח אותם בגוף הבקשה בפורמט JSON.
אימות וטוקן
הבקשה דורשת פרמטר token. מתקבל כל טוקן פעיל בחשבון, בלי קשר להרשאות שלו ולהגבלת כתובות ה-IP שהוגדרה לו,
כך שאפשר להשתמש באותו טוקן שהקוד שלך כבר משתמש בו. ראו אימות וטוקנים.
פרמטרים
| פרמטר | חובה | תיאור |
|---|---|---|
token | חובה | טוקן הזדהות שיצרת במערכת. כל טוקן פעיל מתקבל. |
get / post | חובה | מציין למערכת באיזו שיטה נשלחו הפרמטרים. יש לשלוח אחד מהם בלבד: get=1 בשליחת GET, או post=2 בשליחת POST. (בפורמט JSON אין צורך בפרמטר זה.) |
דוגמאות קוד
curl "https://www.micropay.co.il/extApi/tlsCheck.php?get=1&token=XXXXX"curl -X POST https://www.micropay.co.il/extApi/tlsCheck.php \ -H "Content-Type: application/json" \ -d '{"token":"XXXXX"}'
// Same project and server that send your messages System.Net.ServicePointManager.SecurityProtocol |= System.Net.SecurityProtocolType.Tls12; HttpClient client = new HttpClient(); string answer = client.GetStringAsync("https://www.micropay.co.il/extApi/tlsCheck.php?get=1&token=XXXXX").Result; Console.WriteLine(answer); // OK TLS1.2
$ch = curl_init("https://www.micropay.co.il/extApi/tlsCheck.php?get=1&token=XXXXX"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); echo curl_exec($ch); // OK TLS1.2
תשובת השרת
בקריאה רגילה המערכת מחזירה שורה אחת. במצב JSON, message הוא המילה הראשונה בתשובה, הגרסה נמצאת ב-data.tls, ו-data.supported הוא true כשהגרסה נתמכת. data כולל תמיד את remoteIP.
תשובה רגילה (טקסט)
# תקין OK TLS1.2 # גרסה ישנה, צריך לתקן OLD_TLS TLS1.0 # שגיאה ERROR --> Description: token parameter, invalid or missing
תשובה ב-JSON
// תקין {"status":1,"message":"OK","data":{"tls":"1.2","supported":true,"remoteIP":"203.0.113.10"}} // גרסה ישנה {"status":1,"message":"OLD_TLS","data":{"tls":"1.0","supported":false,"remoteIP":"203.0.113.10"}}
טבלת קודי תשובה
| ערך | status ב-JSON | משמעות |
|---|---|---|
OK TLS1.2 | 1 | החיבור תקין. אין צורך לעשות דבר. |
OK TLS1.3 | 1 | החיבור תקין. אין צורך לעשות דבר. |
OLD_TLS TLS1.0 | 1 | הקוד מתחבר בגרסה ישנה. יש להפעיל TLS 1.2 (ראו בהמשך). |
OLD_TLS TLS1.1 | 1 | הקוד מתחבר בגרסה ישנה. יש להפעיל TLS 1.2 (ראו בהמשך). |
NO_TLS | 1 | הבקשה נשלחה ב-http רגיל, בלי הצפנה. יש לשנות את הכתובת ל-https://. |
UNKNOWN | 1 | לא ניתן היה לזהות את הגרסה. נסו שוב, ואם זה חוזר פנו לתמיכה. |
ERROR | 0 | שגיאה באחד הפרמטרים (למשל טוקן חסר או שגוי). ב-JSON התיאור נמצא ב-data.description. |
איך מפעילים TLS 1.2
| סביבה | מה עושים |
|---|---|
| C# / .NET Framework | מוסיפים לפני הקריאה הראשונה (או פעם אחת בעליית האפליקציה): ServicePointManager.SecurityProtocol |= SecurityProtocolType.Tls12;. בפרויקט .NET 4.0 משתמשים ב-(SecurityProtocolType)3072 (נדרש .NET 4.5 מותקן בשרת). לטווח ארוך מומלץ לעבור ל-.NET Framework 4.8 או ל-.NET 6 ומעלה. |
| PHP / curl | נדרשת גרסת OpenSSL 1.0.1 ומעלה. בגרסאות ישנות ניתן להגדיר curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);. |
| שרת Windows ישן | Windows Server 2008 / 2008 R2 ו-Windows 7 צריכים עדכון של מיקרוסופט כדי לתמוך ב-TLS 1.2, וגרסאות ישנות יותר אינן תומכות בכלל. פנו לספק האחסון או למנהל השרת. |
שאלות נפוצות
איך בודקים באיזו גרסת TLS הקוד שלי מתחבר?
שולחים מהקוד שלך, מאותו שרת ובאותה ספרייה שבה אתה שולח הודעות, בקשה לכתובת tlsCheck.php עם הטוקן. התשובה OK TLS1.2 או OK TLS1.3 אומרת שהחיבור תקין.
מה עושים אם התשובה היא OLD_TLS?
יש להפעיל TLS 1.2 בקוד או בשרת, לפי הטבלה למעלה, ולהריץ את הבדיקה שוב.
איזה טוקן צריך לבדיקה?
כל טוקן פעיל בחשבון, בלי קשר להרשאות שלו או להגבלת כתובות IP. אפשר להשתמש בטוקן שהקוד שלך כבר משתמש בו.
האם הבדיקה עולה כסף או שולחת הודעה?
לא. הבדיקה רק מחזירה את גרסת ה-TLS, ואינה שולחת הודעות ואינה מחויבת.