واجهة برمجة المستخدم

استرجاع الملف الشخصي ومعلومات الحساب للمستخدم المُصادَق عليه.

توفر واجهة برمجة المستخدم الوصول إلى الملف الشخصي وتفاصيل الحساب للمستخدم المُصادَق عليه حالياً.

تستخدم جميع هياكل الاستجابة أسماء حقول بتنسيق snake_case.

Endpoints

GET/api/v1/user

الحصول على الملف الشخصي

GET/api/v1/user

يُرجع الملف الشخصي ومعلومات الحساب للمستخدم المُصادَق عليه حالياً.

حقول الاستجابة

idstring

معرّف المستخدم الفريد

emailstring

عنوان البريد الإلكتروني للمستخدم

first_namestring or null

الاسم الأول للمستخدم

last_namestring or null

اسم العائلة للمستخدم

language_preferencestring

رمز اللغة المفضلة (افتراضي: "en")

created_atstring

طابع زمني لإنشاء الحساب بتنسيق ISO 8601

updated_atstring

طابع زمني لآخر تحديث بتنسيق ISO 8601

plan_tierstring

الخطة الحالية: "entrepreneur" أو "pro" أو "business"

subscription_statusstring or null

حالة اشتراك Stripe (مثل: "active" أو "past_due" أو "canceled")

current_period_endstring or null

تاريخ نهاية فترة الفوترة الحالية بتنسيق ISO 8601

storage_used_bytesinteger

إجمالي مساحة تخزين الملفات المستخدمة بالبايت

subdomainstring or null

النطاق الفرعي المخصص (مثل: "acme" لـ acme.nueform.io). خطة Pro وما فوق.

custom_domainstring or null

النطاق المخصص (مثل: "forms.acme.com"). خطة Pro وما فوق.

custom_domain_verified_atstring or null

طابع زمني بتنسيق ISO 8601 عند التحقق من النطاق المخصص. null إذا كان قيد الانتظار.

الاستجابة

json

{
  "id": "665a0a1b2c3d4e5f6a7b8c9d",
  "email": "alice@example.com",
  "first_name": "Alice",
  "last_name": "Johnson",
  "language_preference": "en",
  "created_at": "2025-11-01T10:00:00.000Z",
  "updated_at": "2026-02-28T08:15:00.000Z",
  "plan_tier": "pro",
  "subscription_status": "active",
  "current_period_end": "2026-03-15T00:00:00.000Z",
  "storage_used_bytes": 52428800,
  "subdomain": "acme",
  "custom_domain": "forms.acme.com",
  "custom_domain_verified_at": "2026-01-20T14:30:00.000Z"
}

أمثلة على الكود

bash

curl -X GET "https://api.nueform.io/api/v1/user" \
  -H "Authorization: Bearer YOUR_API_KEY"

استجابات الأخطاء

استجابات الأخطاء القياسية التي تُرجعها نقطة النهاية هذه.

رموز الأخطاء

401Unauthorized

مفتاح API مفقود أو غير صالح

404Not Found

المستخدم غير موجود

500Server Error

خطأ داخلي في الخادم

مثال على خطأ

json

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key",
    "status": 401
  }
}

آخر تحديث: 6 أبريل 2026