التوثيق والوصول

Textly هو عبارة عن Http API بسيط، من اجل استخدامه يجب ان تحصل على Bearer token من خلال ال dashboard

الحصول على API key

• قم بفتح لوحة التحكم
• قم بالتسجيل دخول الي حسابك
• بعد التسجيل دخول بنجاح سوف يتم أخدك الي الصفحة الرئيسية للوحة التحكم
• اظغط على خيارات المطورين
• اظغط على توليد مفتاح جديد وقم بإعطاء المفتاح إسم
• قم بنسخ المفتاح

إستعمال ال API key

بعد الحصول على المفتاح من لوحة التحكم تستطيع اختباره من خلال إرسال طلب GET /api/v1/client/me مع المفتاح كا Bearer token في ال header الخاص بي Authorization

TypeScript

const response = await fetch("https://api.textly.ly/api/v1/client/me", {
  method: "GET",
  headers: new Headers({
    Authorization: "Bearer <YOUR API KEY>",
  }),
});

console.log(await response.json()); // { client: { ... } }

PHP (Laravel)

use Illuminate\Support\Facades\Http;

$response = Http::withHeaders([ 'Authorization' => 'Bearer $token' ])
  ->get('https://api.textly.ly/api/v1/client/me', []);

info($response->json()); // { client: { ... } }

Curl

curl -X GET https://api.textly.ly/api/v1/client/me \
     -H "Authorization: Bearer <YOUR API KEY>"

التعامل مع الاخطاء

يمكن ان يرد عليك textly بخطأ في حالة:

• ان المفتاح الذي استعملته غير صالح وهذا يعني انه قد تم حذفه من النظام
• تم ايقاف حسابك

يمكنك فهم الخطأ بشكل أعمق من خلال قراءة جسم الاستجابة

{
  "errors": [
    {
      "message": "Unauthorized",
      "error_code": "UNAUTHORIZED"
    }
  ]
}

تذكر بأنك مسؤول على أمن ال api key الخاص بك