غالبًا ما يبحث المطورون عن طرق فعالة لدمج الخدمات المالية في تطبيقاتهم، ويبرز Brex API كحل قوي لإدارة حدود الإنفاق والمعاملات وموارد الفريق. يرشدك هذا المقال خلال عملية الوصول إلى Brex API واستخدامه. ستتعلم كيفية إعداد المصادقة، واستكشاف نقاط النهاية، ودمج API في أنظمتك.
أثناء المتابعة، تذكر أن التعديلات الصغيرة في نهجك، مثل اختيار النطاقات الصحيحة أثناء إنشاء الرمز المميز، يمكن أن تؤثر بشكل كبير على نجاح التكامل. لذلك، انتبه جيدًا لكل خطوة لضمان الاتصال السلس.
ما هو Brex API؟
يوفر Brex API واجهة RESTful تمكن المطورين من أتمتة وتخصيص سير العمل المالي داخل منصة Brex. تقدم Brex، وهي شركة تكنولوجيا مالية، خدمات مثل البطاقات المؤسسية، وإدارة الإنفاق، وتتبع المصروفات. وبالتالي، يتيح لك Brex API التفاعل مع هذه الميزات برمجياً.
يتضمن Brex API العديد من واجهات برمجة التطبيقات المتخصصة، مثل Team API لإدارة المستخدمين والبطاقات، و Transactions API لجلب المعاملات المستقرة، و Onboarding API للتعامل مع الإحالات. كل واحدة من هذه الواجهات تلبي جوانب مختلفة من الإدارة المالية، مما يتيح لك بناء تقارير مخصصة، أو أتمتة دعوات المستخدمين، أو تتبع النفقات في الوقت الفعلي.
بالإضافة إلى ذلك، تركز Brex على الأمان والامتثال، مما يضمن توافق تفاعلات API مع معايير الصناعة. لذلك، عندما تستخدم Brex API، فإنك تحصل على أدوات تدعم العمليات المالية القابلة للتطوير دون المساس بسلامة البيانات.
لماذا يجب عليك استخدام Brex API؟
يجب عليك استخدام Brex API إذا كان تطبيقك يتطلب التكامل مع الأدوات المالية للشركات. على سبيل المثال، غالبًا ما تحتاج فرق التمويل إلى مزامنة بيانات المعاملات مع برامج المحاسبة، ويسهل Brex API ذلك من خلال توفير نقاط نهاية لإدراج المعاملات والحسابات.
علاوة على ذلك، يقلل API من الجهود اليدوية في إدارة حدود الإنفاق ووصول المستخدمين. يمكنك أتمتة إنشاء البطاقات، وتحديد الحدود الشهرية، ومراقبة الأنشطة، مما يبسط العمليات للشركات المتنامية. بالإضافة إلى ذلك، يمكن للشركاء في المحاسبة أو الموارد البشرية الاستفادة من Onboarding API لإنشاء روابط إحالة مخصصة، مما يعزز عمليات اكتساب العملاء.
ومع ذلك، تكمن القيمة الحقيقية في مرونته. يمكنك دمج Brex API مع الأنظمة الحالية لإنشاء لوحات تحكم أو تنبيهات مخصصة، مما يضمن تدفق البيانات المالية بكفاءة عبر المنصات. نتيجة لذلك، يوفر المطورون الوقت ويقللون الأخطاء مقارنة بإدخال البيانات اليدوي.
كيف تبدأ الوصول إلى Brex API؟
للبدء في الوصول إلى Brex API، يجب عليك أولاً التسجيل للحصول على حساب Brex إذا لم يكن لديك واحد. قم بزيارة brex.com وأنشئ حسابًا كمسؤول، حيث يمكن فقط لمسؤولي الحساب أو مسؤولي البطاقات إنشاء رموز API.
بعد ذلك، قم بتسجيل الدخول إلى لوحة تحكم Brex.
انتقل إلى قسم المطورين تحت الإعدادات. هنا، انقر على إنشاء رمز مميز لبدء العملية. قم بتوفير اسم للرمز المميز، مما يساعد في تحديد الغرض منه لاحقًا، مثل "رمز التكامل للتطبيق".
علاوة على ذلك، تقوم بتحديد النطاقات المناسبة خلال هذه الخطوة. تحدد النطاقات مستويات الوصول إلى البيانات، مثل الوصول للقراءة للمعاملات أو أذونات الكتابة لإدارة المستخدمين. بعد تأكيد اختياراتك، انقر على "السماح بالوصول"، ويقوم النظام بإنشاء الرمز المميز.
من المهم أن تقوم بنسخ وتخزين هذا الرمز المميز بشكل آمن فوراً، حيث تقوم Brex بإخفائه بعد الإنشاء لأسباب أمنية. إذا فقدته، فما عليك سوى إنشاء رمز جديد. تنتهي صلاحية الرموز المميزة بعد 90 يومًا من عدم النشاط، لذا يجب عليك مراقبة الاستخدام لتجنب الانقطاعات.
بمجرد حصولك على الرمز المميز، يمكنك اختبار الاتصال الأساسي. على سبيل المثال، يمكنك استخدام أداة مثل curl لتقديم طلب GET بسيط إلى نقطة نهاية، بما في ذلك الرمز المميز في عنوان Authorization. هذا يتحقق من أن إعدادك يعمل بشكل صحيح.
كيفية المصادقة باستخدام Brex API؟
تتم المصادقة مع Brex API باستخدام رموز bearer. بشكل خاص، تقوم بتضمين الرمز المميز في عنوان Authorization لكل طلب، بتنسيق "Bearer {your_token}".
على سبيل المثال، فكر في مثال curl هذا:
curl -X GET https://platform.brexapis.com/v2/users/me \
-H "Authorization: Bearer bxt_jBWQLZXtu1f4sVT6UjaWPp7Gh9nVGjzEZgRX"
يطلب هذا الطلب تفاصيل المستخدم الحالي. إذا نجح، فإنه يعيد بيانات JSON حول المستخدم.
علاوة على ذلك، يدعم Brex رموز المستخدمين، والتي ترتبط بامتيازات إدارية محددة. تقوم بإنشاء هذه الرموز كما هو موضح سابقًا، مع التأكد من اختيار النطاقات التي تتناسب مع احتياجاتك. على سبيل المثال، إذا كنت تخطط لإدارة البطاقات، فحدد نطاقات للقراءة والكتابة على نقاط نهاية البطاقة.
ومع ذلك، إذا تعرض رمز مميز للاختراق، فيجب عليك إبطاله فورًا من صفحة المطور في لوحة التحكم. تتسبب الرموز المميزة الملغاة في فشل استدعاءات API اللاحقة مع خطأ 401، مما يحمي حسابك.
في الممارسة العملية، تقوم بتنفيذ إدارة الرمز المميز في رمز تطبيقك. تبسط المكتبات مثل وحدة requests في Python هذا الأمر:
import requests
headers = {
'Authorization': 'Bearer your_token_here'
}
response = requests.get('https://platform.brexapis.com/v2/users/me', headers=headers)
print(response.json())
يوضح مقتطف الشفرة هذا المصادقة النشطة في نص برمجي.
ما هي نقاط نهاية Brex API الرئيسية؟
يوفر Brex API نقاط نهاية متنوعة عبر العديد من واجهات برمجة التطبيقات. تبدأ باستكشاف Team API، الذي يتعامل مع المستخدمين، الأقسام، المواقع، البطاقات، والمزيد.
- بالنسبة للمستخدمين، يمكنك سرد جميع المستخدمين باستخدام GET /v2/users، والتصفية حسب البريد الإلكتروني أو المعرف. تتضمن المعلمات `cursor` للتقسيم و `limit` للتحكم في حجم الاستجابة. وبالمثل، يمكنك دعوة مستخدم جديد عبر POST /v2/users، مع توفير `first_name` و `last_name` و `email` و `manager_id` الاختياري.
علاوة على ذلك، يمكنك تحديث المستخدمين باستخدام PUT /v2/users/{id}، وتغيير الحالة إلى ACTIVE أو DISABLED. يمكنك أيضًا تعيين حدود شهرية باستخدام POST /v2/users/{id}/limit، مع تحديد المبلغ في الجسم.
- بالنسبة للأقسام، يمكنك إنشاء واحد باستخدام POST /v2/departments، مع طلب `name`. يمكنك سردها عبر GET /v2/departments، واسترداد تفاصيل محددة باستخدام GET /v2/departments/{id}.
- تتبع المواقع نمطًا مشابهًا: POST /v2/locations للإنشاء، GET /v2/locations للسرد.
- العناوين، التي تمثل الأدوار الوظيفية، تستخدم نقاط نهاية مثل POST /v2/titles و GET /v2/titles/{id}.
- تشكل البطاقات جزءًا أساسيًا. يمكنك سرد البطاقات باستخدام GET /v2/cards، والتي يتم تصفيتها بواسطة `user_id`. لإنشاء بطاقة، استخدم POST /v2/cards مع تفاصيل مثل `owner`، `card_type` (VIRTUAL أو PHYSICAL)، و `spend_controls`. تتضمن `spend_controls` `limit_type` والمبالغ.
بالإضافة إلى ذلك، يمكنك تحديث البطاقات عبر PUT /v2/cards/{id}، أو قفلها باستخدام POST /v2/cards/{id}/lock (مع توفير سبب مثل FRAUD)، أو إنهائها باستخدام POST /v2/cards/{id}/terminate.
- تشمل العمليات الحساسة GET /v2/cards/{id}/pan لأرقام البطاقات و POST /v2/cards/{id}/secure_email لإرسال التفاصيل بشكل آمن.
- تحتوي الكيانات القانونية والشركات على نقاط نهاية للقراءة فقط مثل GET /v2/legal_entities و GET /v2/company.
- بالانتقال إلى Transactions API، يمكنك جلب معاملات البطاقة المستقرة باستخدام GET /v2/transactions/card/primary، باستخدام معلمات مثل `posted_at_start` لتصفية التاريخ. بالنسبة للحسابات النقدية، يسرد GET /v2/transactions/cash/{id} المعاملات.
- تتضمن نقاط نهاية الحسابات GET /v2/accounts/card لحسابات البطاقات و GET /v2/accounts/cash للحسابات النقدية. يمكنك استرداد الكشوفات باستخدام GET /v2/accounts/card/primary/statements.
- يركز Onboarding API على الإحالات. يمكنك إنشاء إحالات باستخدام POST /v1/referrals، مع توفير `referral_code` وتفاصيل مقدم الطلب. قم بسردها عبر GET /v1/referrals، واحصل على تفاصيل محددة باستخدام GET /v1/referrals/{id}. تستخدم عمليات تحميل المستندات POST /v1/referrals/{id}/document_upload.
تتضمن واجهات برمجة التطبيقات الأخرى Payments للتحويلات (GET /v2/transfers)، Webhooks للإشعارات، و Fields API لإدارة الحقول المخصصة.
تدعم جميع نقاط نهاية القائمة التقسيم باستخدام `cursor` و `limit`، مما يضمن استرجاع البيانات بكفاءة.
كيفية استخدام Brex API للمعاملات؟
تستخدم Brex API للمعاملات عن طريق استدعاء نقاط النهاية في Transactions API. أولاً، تحدد نوع الحساب—بطاقة أو نقداً.
بالنسبة لمعاملات البطاقة، ترسل GET /v2/transactions/card/primary. هذا يعيد المشتريات المستقرة، المبالغ المستردة، وعمليات استرداد المدفوعات. يمكنك التصفية بواسطة user_ids أو posted_at_start، مثل "2025-01-01T00:00:00Z".
تتضمن الاستجابة تفاصيل مثل المبلغ، الوصف، التاجر، و expense_id إذا تم توسيعه.
بالنسبة للمعاملات النقدية، تحدد معرف الحساب في GET /v2/transactions/cash/{id}. هذا يسرد جميع الأنشطة لذلك الحساب النقدي.
لإدارة الحسابات، تسرد حسابات البطاقات باستخدام GET /v2/accounts/card، والتي تعيد المعرفات والحالات. وبالمثل، يوفر GET /v2/accounts/cash تفاصيل الحساب النقدي.
علاوة على ذلك، تجلب الكشوفات للتدقيق. استخدم GET /v2/accounts/card/primary/statements للحصول على كشوفات البطاقات النهائية، مع تقسيم الصفحات حسب الحاجة.
في الكود، تقوم بتنفيذ هذا على النحو التالي (مثال Python):
import requests
headers = {
'Authorization': 'Bearer your_token_here'
}
params = {
'posted_at_start': '2025-12-01T00:00:00Z',
'limit': 50
}
response = requests.get('https://platform.brexapis.com/v2/transactions/card/primary', headers=headers, params=params)
transactions = response.json()['items']
for tx in transactions:
print(f"Amount: {tx['amount']['amount']}, Description: {tx['description']}")
يجلب هذا النص البرمجي المعاملات الأخيرة ويطبعها، مما يوضح الاستخدام العملي.
بالإضافة إلى ذلك، تتعامل مع الأخطاء مثل 404 للمعرفات غير الصالحة عن طريق التحقق من response.status_code.
كيفية إدارة الفرق باستخدام Brex Team API؟
تدير الفرق باستخدام نقاط نهاية Team API. ابدأ بسرد المستخدمين باستخدام GET /v2/users. يساعدك هذا في تدقيق أعضاء الفريق الحاليين.
لإضافة مستخدم، POST /v2/users مع الحقول المطلوبة:
{
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"department_id": "dept_123"
}
يرسل النظام بريدًا إلكترونيًا للدعوة تلقائيًا.
تقوم بتحديث تفاصيل المستخدم، مثل تعيين مدير جديد، عبر PUT /v2/users/{id}.
للتحكم في الإنفاق، POST /v2/users/{id}/limit يحدد الميزانيات الشهرية.
تعزز الأقسام والمواقع التنظيم. يمكنك إنشاء قسم باستخدام POST /v2/departments:
{
"name": "Engineering",
"description": "Software development team"
}
ثم، قم بتعيين المستخدمين إليه أثناء الدعوة أو التحديث.
ترتبط البطاقات بالمستخدمين. يمكنك إنشاء بطاقة افتراضية لمستخدم:
{
"owner": {
"user_id": "user_456"
},
"card_name": "Project Card",
"card_type": "VIRTUAL",
"limit_type": "CARD",
"spend_controls": {
"limit": {
"amount": 5000,
"currency": "USD"
}
}
}
أرسل هذا إلى /v2/cards.
لاحقًا، يمكنك قفل بطاقة إذا لزم الأمر: POST /v2/cards/{id}/lock مع سبب "OTHER".
يضمن هذا النهج إدارة فريق آمنة.
دمج Brex API مع رمز تطبيقك: أمثلة على التعليمات البرمجية
يمكنك دمج Brex API عن طريق تضمين استدعاءات API في قاعدة التعليمات البرمجية الخاصة بك. استخدم مكتبات مثل requests في Python أو axios في JavaScript.
لمثال Node.js، قم بتثبيت axios:
npm install axios
ثم، جلب المستخدمين:
const axios = require('axios');
const headers = {
Authorization: 'Bearer your_token_here'
};
axios.get('https://platform.brexapis.com/v2/users', { headers })
.then(response => {
console.log(response.data.items);
})
.catch(error => {
console.error(error.response.data);
});
يسجل هذا بيانات المستخدم.
لعمليات تكامل أكثر تعقيدًا، يمكنك استخدام webhooks. اشترك في الأحداث عبر Webhooks API، مع إعداد نقاط النهاية لتلقي الإشعارات حول تحديثات المعاملات.
في Python، تعامل مع ترقيم الصفحات لمجموعات البيانات الكبيرة:
def fetch_all_users(headers, cursor=None):
users = []
while True:
params = {'limit': 100, 'cursor': cursor}
response = requests.get('https://platform.brexapis.com/v2/users', headers=headers, params=params)
data = response.json()
users.extend(data['items'])
cursor = data['next_cursor']
if not cursor:
break
return users
تقوم هذه الدالة باسترداد جميع المستخدمين بشكل تكراري.
يجب عليك أيضًا تأمين البيانات الحساسة، مثل أرقام البطاقات، باستخدام GET /v2/cards/{id}/pan فقط عند الضرورة وعدم تخزين أي شيء محليًا.
كيف يمكنك اختبار Brex API باستخدام Apidog؟
يمكنك اختبار Brex API بفعالية باستخدام Apidog، وهي منصة متكاملة لتطوير واجهات برمجة التطبيقات. يتيح لك Apidog تصميم واجهات برمجة التطبيقات وتصحيحها ومحاكاتها واختبارها وتوثيقها بشكل بديهي.
بعد ذلك، قم بإعداد المصادقة عن طريق إضافة رمز bearer الخاص بك في المتغيرات العامة أو إعدادات البيئة. ينطبق هذا على جميع الطلبات.
ثم تقوم بإرسال الطلبات، مثل GET /v2/users/me، وعرض الردود في واجهة سهلة الاستخدام. يبرز Apidog هياكل JSON والأخطاء.
علاوة على ذلك، يمكنك إنشاء سيناريوهات اختبار مع التأكيدات. على سبيل المثال، تأكد من أن استجابة المعاملة لها حالة 200 وتحتوي على "amount".
تحاكي ميزة المحاكاة في Apidog الاستجابات لنقاط النهاية غير المتوفرة، مما يساعد في التطوير.
بالإضافة إلى ذلك، يمكنك إنشاء وثائق مع عينات رمز بلغات متعددة، ومشاركتها مع فريقك.
باستخدام Apidog، يمكنك تبسيط اختبار Brex API، واكتشاف المشكلات مبكرًا.
ما هي أفضل الممارسات لاستخدام Brex API؟
تتبع أفضل الممارسات لتحسين استخدام Brex API. استخدم دائمًا HTTPS وقم بتخزين الرموز المميزة بشكل آمن، ربما في متغيرات البيئة أو الخزائن.
نفذ معالجة حدود المعدل، حيث يفرض Brex قيودًا—أعد المحاولة مع التراجع الأسي عند أخطاء 429.
- قم بتقسيم الطلبات لتجنب انتهاء المهلة؛ استخدم المؤشر والحد باستمرار.
- راقب انتهاء صلاحية الرمز المميز وقم بتجديده تلقائيًا.
- تحقق من صحة المدخلات قبل الإرسال لمنع أخطاء 400.
- سجل استدعاءات API لتصحيح الأخطاء، ولكن اجعل البيانات الحساسة مجهولة المصدر.
- استخدم مفاتيح الاستقلالية لـ POST/PUT لتجنب التكرارات.
- دمج معالجة الأخطاء: اربط رموز HTTP بالإجراءات، مثل تحديث الرموز المميزة عند 401.
- اختبر في بيئات الاختبار قبل الإنتاج.
- ابق على اطلاع على سجل تغييرات Brex للتغييرات.
تضمن هذه الممارسات عمليات تكامل موثوقة.
المشكلات الشائعة وكيفية استكشاف أخطاء Brex API وإصلاحها؟
قد تواجه مشكلات مثل فشل المصادقة. إذا حصلت على 401، فتحقق من صلاحية الرمز المميز—أعد إنشاءه إذا انتهت صلاحيته.
- بالنسبة لـ 403 ممنوع، تحقق من أن النطاقات تتطابق مع نقطة النهاية.
- 404 غير موجود غالبًا ما يعني معرفات غير صالحة؛ تحقق مرة أخرى من المسارات.
- تجاوز حد المعدل يؤدي إلى 429؛ نفذ التراجع.
- تتطلب أخطاء الشبكة منطق إعادة المحاولة.
استخدم مجموعات Brex Postman للاختبار الأولي، متفرعًا من مساحة العمل الخاصة بهم.
إذا استمرت المشكلات، استشر الوثائق أو اتصل بالدعم.
الخلاصة
أنت الآن تفهم كيفية الوصول إلى Brex API واستخدامه بشكل شامل. من المصادقة إلى استخدام نقاط النهاية والاختبار باستخدام Apidog، تمكن هذه الخطوات من عمليات تكامل قوية. قم بتطبيقها لتعزيز سير عملك المالي بكفاءة.
