תחילת העבודה

ממשק ה-API של Finexly מספק שערי חליפין בזמן אמת והיסטוריים עבור יותר מ-170 מטבעות. להתחיל זה פשוט:

  1. הירשם לחשבון חינם
  2. קבל את מפתח הגישה ל-API מלוח הבקרה
  3. בצע את בקשת ה-API הראשונה שלך

כתובת בסיס

https://api.finexly.com/v1/

אימות

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

אפשרות 1: כותרת הרשאה (מומלץ)

כותרת הרשאה (נדרש)

Authorization: Bearer YOUR_API_KEY

אפשרות 2: פרמטר שאילתה

העבר את מפתח ה-API שלך כפרמטר שאילתה:

GET https://api.finexly.com/v1/rate?from=USD&to=EUR&api_key=YOUR_API_KEY

⚠ הערת אבטחה: מפתחות API בכתובות URL עשויים להירשם ביומני גישה לשרת ויכולים לדלוף דרך כותרות HTTP Referrer. לשימוש בייצור, אנו ממליצים על שיטת כותרת Authorization. הפרמטר בשאילתה מסופק לנוחות לצורך בדיקות מהירות ואינטגרציות פשוטות.

הגבלת קצב: בדוק את כותרות התגובה לשימוש הנוכחי שלך: X-RateLimit-Limit, X-RateLimit-Used, X-RateLimit-Units

נקודות קצה של API

GET /v1/currencies

קבל רשימה של כל קודי המטבע הנתמכים.

פרמטרים

שם סוג נדרש תיאור

דוגמה

GET https://api.finexly.com/v1/currencies

// תגובה
[
    "AED",
    "ANG",
    "AUD",
    "EUR",
    "GBP",
    "USD"
]
GET /v1/rate

קבל את שער החליפין לזוג מטבעות ספציפי.

פרמטרים

שם סוג נדרש תיאור
from string כן קוד מטבע בסיס (אותיות גדולות)
to string כן קוד מטבע ציטוט (אותיות גדולות)

דוגמה

GET https://api.finexly.com/v1/rate?from=USD&to=EUR

// תגובה
{
    "pair": "USD_EUR",
    "rate": 0.9215
}
GET /v1/convert

קבל שערי חליפין למספר זוגות מטבעות בבקשה אחת.

פרמטרים

שם סוג נדרש תיאור
q string כן זוגות מופרדים בפסיק בפורמט BASE_QUOTE

דוגמה

GET https://api.finexly.com/v1/convert?q=USD_EUR,USD_GBP

// תגובה
{
    "USD_EUR": {
        "rate": 0.9215
    },
    "USD_GBP": {
        "rate": 0.7892
    }
}
GET /v1/convert-amount

המר סכום ספציפי ממטבע אחד לאחר.

פרמטרים

שם סוג נדרש תיאור
from string כן קוד מטבע מקור (אותיות גדולות)
to string כן קוד מטבע יעד (אותיות גדולות)
amount number כן סכום להמרה

דוגמה

GET https://api.finexly.com/v1/convert-amount?from=USD&to=EUR&amount=100

// תגובה
{
    "pair": "USD_EUR",
    "rate": 0.9215,
    "amount": 100,
    "result": 92.15
}

דוגמאות קוד

# Using Authorization header (recommended)
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.finexly.com/v1/rate?from=USD&to=EUR"

# Using query parameter
curl "https://api.finexly.com/v1/rate?from=USD&to=EUR&api_key=YOUR_API_KEY"

# Get multiple rates
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.finexly.com/v1/convert?q=USD_EUR,USD_GBP"

# Convert amount
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.finexly.com/v1/convert-amount?from=USD&to=EUR&amount=100"
<?php
$apiKey = 'YOUR_API_KEY';

// Using cURL
$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.finexly.com/v1/rate?from=USD&to=EUR',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
echo "USD/EUR Rate: " . $data['rate'];
const apiKey = 'YOUR_API_KEY';

// Get single rate
const response = await fetch('https://api.finexly.com/v1/rate?from=USD&to=EUR', {
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
});

const data = await response.json();
console.log(`USD/EUR Rate: ${data.rate}`);

// Convert amount
const convertResponse = await fetch(
  'https://api.finexly.com/v1/convert-amount?from=USD&to=EUR&amount=100',
  { headers: { 'Authorization': `Bearer ${apiKey}` } }
);
const result = await convertResponse.json();
console.log(`100 USD = ${result.result} EUR`);
import requests

api_key = 'YOUR_API_KEY'
headers = {'Authorization': f'Bearer {api_key}'}

# Get single rate
response = requests.get(
    'https://api.finexly.com/v1/rate',
    params={'from': 'USD', 'to': 'EUR'},
    headers=headers
)
data = response.json()
print(f"USD/EUR Rate: {data['rate']}")

# Convert amount
response = requests.get(
    'https://api.finexly.com/v1/convert-amount',
    params={'from': 'USD', 'to': 'EUR', 'amount': 100},
    headers=headers
)
result = response.json()
print(f"100 USD = {result['result']} EUR")

קודי שגיאה

קוד סוג תיאור
400 BAD_REQUEST פרמטרי בקשה לא חוקיים או שדות חובה חסרים.
401 UNAUTHORIZED טוקן API חסר או לא חוקי.
403 FORBIDDEN הגישה נדחתה. החשבון שלך עשוי להיות לא פעיל.
413 PAYLOAD_TOO_LARGE גודל הבקשה חורג מהגודל המרבי המותר.
429 RATE_LIMIT_EXCEEDED חרגת ממגבלת הקצב שלך. בדוק את כותרות X-RateLimit.
500 INTERNAL_ERROR אירעה שגיאת שרת פנימית. אנא נסה שוב.

מחברים מבוססי בינה מלאכותית (MCP)

פינקסלי מדבר את פרוטוקול הקשר של המודל, כך שעוזר בינה מלאכותית יכול לקרוא את השערים ישירות במקום לקבל אותם. זהו ערוץ נפרד מ-REST API למטה: הוא מאמת עם OAuth במקום מפתח API, והוא רק לקריאה.

כתובת URL של השרת

https://mcp.finexly.com

כלים שהוא מציע

שם תיאור
get_exchange_rate השיעור הנוכחי בין שתי מטבעות.
convert_amount המיר סכום, עם חישוב חוצה דרך הדולר האמריקאי במידת הצורך.
list_currencies כל מטבע שאנחנו מכסים.
get_historical_rates שיעורים יומיים לאורך תקופה, עבור זוגות שנאספו ישירות.

אישור

המחבר מפעיל זרימת קוד אישור OAuth 2.1 עם PKCE. הגילוי נמצא בכתובות ה-URL למטה; ההיקף היחיד הוא fx:read, ואין היקף שמעניק גישה לחשבון.

  • https://finexly.com/.well-known/oauth-authorization-server
  • https://finexly.com/oauth/authorize
  • https://finexly.com/oauth/token
  • https://finexly.com/oauth/jwks
מדריך התקנה ותכנון הקצאות →

Tutorials & Guides

Learn how to integrate Finexly with your favorite programming languages and frameworks.