الواجهة البرمجيّة لتينه تُعتبر واجهة RESTful
حيث تتأثر بالعبارة (الفعل) المستخدم للطلب، مثل GET
, POST
, DELETE
, و
لاستخدام تينه على الوجه الأمثل؛ ينبغي أن يُفهم آليّة جريان الطلب، حيث ينبغي في البداية تسجيل تطبيقك
لدى تينه، لتتمكن بذلك الحصول على مفتاحين يمكّنانك من استدعاء و الاستفادة من وظائف وحدات تينه.
يُمكنك تسجيل تطبيقك من خلال ارسال الطلب التالي إلى متصفحك، مع ملاحظة استبدال عبارة {email}
ببريدك الإلكترونيّ، و كذلك أن الردّ على هذا الطلب سيظهر مرّة واحدة فقط،
ثم لن تتمكن من اظهار و قراءة المفتاحين من جديد:
الطلب | |
---|---|
GET | {{teenah_api_url}}/apps/make/{email} |
بعد ارسال الطلب، سيكون الرد على ثلاث حالات، إمّا أن يُقبل البريد و يُضاف إلى قائمة تطبيقات تينه و كود الردّ سيكون 200
، أو في حال كون البريد قد أُضيف مسبقاً، فإن خطأ 403
سيظهر، أو سيظهر خطأ 400
في حال أُدخل البريد بطريقة غير صحيحة:
الردود | |
---|---|
200 |
{ "email":"teenah.app@gmail.com", "app_key":"EfmDF4BFFZR4soOs4mVhpB6MinUQ7G", "app_secret":"$2y$10$xS8AsXVqmyiF5O36mqq.i.kRoKP7.ehbpbzbB6B4e9HOPMYLGZ2tm", "updated_at":"2014-01-29 14:38:37", "created_at":"2014-01-29 14:38:37", "id":7 } |
|
|
403 |
{ "message": "Not authorized to access this resource." } |
|
|
400 |
{ "message": "Bad request." } |
|
إذا تمّ توليد المفتاحين و لاستخدامهما في تطبيقك، فاحفظهما في مكانٍ آمنٍ لديك، و هم في المثال السابق محتويات المتغيرين app_key
و app_secret
، بدون هذين المفتاحين، لن تتمكّن من استدعاء أي وظيفة في تينه، و يظهر لك الخطأ 401
موضحاً عدم صحّة المفتاحين.
يُمكنك الآن استدعاء وظائف تينه، مثل إضافة علاقات الفرد، و المناسبات، و غيرها، شريطة أن تضمّن رؤوس إضافيّة للطلب headers
، ليتمكن تينه من التعرّف على تطبيقك، هذه الرؤوس هي نفسها المفاتيح الخاصّة بتطبيقك:
الرأس | القيمة |
---|---|
X-App-Key |
EfmDF4BFFZR4soOs4mVhpB6MinUQ7G |
X-App-Secret |
$2y$10$xS8AsXVqmyiF5O36mqq.i.kRoKP7.ehbpbzbB6B4e9HOPMYLGZ2tm |
في الجدول المُرفق، شرحاً مفصّلاً لأكواد الردّ التي يُرسلها الخادم (تينه)، لأهميّتها في فهم الذي حدث فعليّاً في الخادم، كقبول الطلب من عدمه:
الكود | المعنى |
---|---|
200 | تم إتمام الطلب بنجاح. |
201 | تم إنشاء العنصر (العناصر) المطلوبة بنجاح. |
204 | تم إتمام الطلب بنجاح، لكن لم يتم الرد بمحتوى. |
400 | فشل الطلب بسبب نقص في الطلب أو خطأ في التحقّق. |
401 | مفتاحي الواجهة البرمجيّة للتطبيق (API) إمّا مفقودين أو غير صحيحين. |
403 | غير مرخّص لك استخدام هذه الوظيفة أو العنصر. |
404 | لم يتم العثور على العنصر المطلوب. |
500 | خطأ داخلي من الخادم. |
انتقل تكرّماً إلى صفحة المستخدمين للتعرّف على آلية دخول المستخدم للحصول على وصول كامل لوظائف النظام المُناطة بالفرد المسجّل للدخول.