bitly

قليلا

جوهرة Ruby لاستخدام API الإصدار 4 bitly لتقصير الروابط وتوسيع الروابط القصيرة وعرض المقاييس عبر المستخدمين والروابط والمؤسسات.

• تثبيت

• الاستخدام

• المصادقة

• إنشاء عميل API

• تقصير رابط

• توسيع رابط

• نقاط نهاية واجهة برمجة التطبيقات المتاحة

• مجموعات

• المنظمات

• المستخدمون

• bitLinks

• bitLinks مخصصة

• الحملات

• BSDS (المجالات القصيرة ذات العلامات التجارية)

• Webhooks

• تخصيص طلبات HTTP

• بناء محول الخاص بك

• تطوير

• المساهمة

• رخصة

• مدونة لقواعد السلوك

تثبيت

أضف هذا السطر إلى Gemfile في التطبيق الخاص بك:

 جوهرة "قامة"

ثم تنفذ:

 تثبيت حزمة $

أو تثبيته بنفسك على النحو التالي:

 $ GEM تثبيت قامة

الاستخدام

للحصول على مقدمة سريعة ، اقرأ منشور المدونة هذا حول كيفية استخدام واجهة برمجة تطبيقات bitly في Ruby.

المصادقة

تتطلب جميع نقاط نهاية API المصادقة مع رمز Oauth. يمكنك الحصول على رمز Oauth الخاص بك من وحدة التحكم الصغيرة. انقر فوق القائمة المنسدلة على الحساب ، ثم إعدادات الملف الشخصي ثم رمز الوصول العام . املأ كلمة المرور الخاصة بك ويمكنك إنشاء رمز الوصول إلى OAuth.

للحصول على طرق أخرى لإنشاء رموز الوصول للمستخدمين عبر تدفقات OAUTH ، راجع وثائق المصادقة.

بمجرد حصولك على رمز الوصول ، يمكنك استخدام جميع أساليب API.

إنشاء عميل API

جميع أساليب API متوفرة من خلال Bitly::API::Client . قم بتهيئة العميل برمز الوصول مثل SO:

 Client = bitly :: API :: Client.new (الرمز المميز: رمز)

يمكنك بعد ذلك استخدام العميل لتنفيذ الإجراءات باستخدام واجهة برمجة التطبيقات

تقصير رابط

مع عميل مصادق ، يمكنك تقصير رابط مثل ذلك:

 bitLink = client.shorten (long_url: "http://example.com") bitlink.link# => http://bit.ly/2oujim0

توسيع رابط

مع مرخصة يمكنك توسيع أي bitlink.

 bitLink = client.expand (bitLink: "bit.ly/2oujim0") pittlink.long_url# => http://example.com

نقاط نهاية واجهة برمجة التطبيقات المتاحة

تدعم هذه الأحجار الكريمة نقاط نهاية API API النشطة التالية لـ thebitly API.

مجموعات

مجموعات الوثائق

• استرداد المجموعات ( GET /v4/groups )

• استرداد المجموعة ( GET /v4/groups/{group_guid} )

• مجموعة التحديث ( PATCH /v4/groups/{group_guid} )

• استرداد العلامات حسب المجموعة ( GET /v4/groups/{group_guid}/tags )

• استرداد تفضيلات المجموعة ( GET /v4/groups/{group_guid}/preferences )

• تحديث تفضيلات المجموعة ( PATCH /v4/groups/{group_guid}/preferences )

• استرداد BitLinks بواسطة المجموعة ( GET /v4/groups/{group_guid}/bitlinks )

• استرداد BitLinks المصنفة بواسطة المجموعة ( GET /v4/groups/{group_guid}/bitlinks/{sort} )

• استرداد تعدادات اختصار المجموعة ( GET /v4/groups/{group_guid}/shorten_counts )

• استرداد انقر فوق مقاييس لمجموعة من خلال إحالة الشبكات ( GET /v4/groups/{group_guid}/referring_networks )

• استرجاع انقر فوق مقاييس لمجموعة من البلدان ( GET /v4/groups/{group_guid}/countries )

• [Premium] استرداد انقر فوق مقاييس لمجموعة من قبل المدينة ( GET /v4/groups/{group_guid}/cities )

• [Premium] Get Get Group Overrides ( GET /v4/groups/{group_guid}/overrides )

المنظمات

وثائق المنظمات

• استرداد المنظمات ( GET /v4/organizations )

• استرداد المنظمة ( GET /v4/organizations/{organization_guid} )

• استرداد التهم تقصير المنظمة ( GET /v4/organizations/{organization_guid}/shorten_counts )

المستخدمون

مستندات المستخدمين

• استرداد المستخدم ( GET /v4/user )

• تحديث المستخدم ( PATCH /v4/user )

bitLinks

وثائق BitLinks

• تقصير رابط ( POST /v4/shorten )

• قم بتوسيع bitLink ( POST /v4/expand )

• استرداد bitLink ( GET /v4/bitlinks/{bitlink} )

• إنشاء bitLink ( POST /v4/bitlinks )

• تحديث bitLink ( PATCH /v4/bitlinks/{bitlink} )

• حذف bitLink غير محدّل ( DELETE /v4/bitlinks/{bitlink} )

• احصل على نقرات للحصول على bitLink ( GET /v4/bitlinks/{bitlink}/clicks )

• احصل على ملخص نقرات لـ bitLink ( GET /v4/bitlinks/{bitlink}/clicks/summary )

• احصل على مقاييس لـ bitLink بواسطة البلدان ( GET /v4/bitlinks/{bitlink}/countries )

• احصل على مقاييس لـ bitLink بواسطة المرجعين ( GET /v4/bitlinks/{bitlink}/referrers )

• احصل على مقاييس لـ bitLink عن طريق إحالة المجالات ( GET /v4/bitlinks/{bitlink}/referring_domains )

• احصل على مقاييس لـ bitLink بواسطة المرجعين حسب المجال ( GET /v4/bitlinks/{bitlink}/referrers_by_domains )

• [Premium] احصل على مقاييس لـ bitLink by City ( GET /v4/bitlinks/{bitlink}/cities )

• [Premium] احصل على مقاييس لـ bitLink حسب نوع الجهاز ( GET /v4/bitlinks/{bitlink}/devices )

• [Premium] استرداد رمز QR لـ bitLink ( GET /v4/bitlinks/{bitlink}/qr )

• [Premium] قم بتحديث رمز QR ( PATCH /v4/bitlinks/{bitlink}/qr )

• [Premium] إنشاء رمز QR ( POST /v4/bitlinks/{bitlink}/qr )

bitLinks مخصصة

• أضف bitLink مخصص ( POST /v4/custom_bitlinks )

• [Premium] استرداد BitLink المخصص ( GET /v4/custom_bitlinks/{custom_bitlink} )

• [Premium] تحديث BitLink المخصص ( PATCH /v4/custom_bitlinks/{custom_bitlink} )

• [Premium] احصل على مقاييس لـ BitLink المخصصة حسب الوجهة ( GET /v4/custom_bitlinks/{custom_bitlink}/clicks_by_destination )

• [Premium] احصل على نقرات للحصول على سجل Custom Bitlin بالكامل ( GET /v4/custom_bitlinks/{custom_bitlink}/clicks )

الحملات

• [Premium] استرداد الحملات ( GET /v4/campaigns )

• [Premium] Create ( POST /v4/campaigns )

• [Premium] Retrieve Campaign ( GET /v4/campaigns/{campaign_guid} )

• [Premium] Update Campaign ( PATCH /v4/campaigns/{campaign_guid} )

• [Premium] استرداد القنوات ( GET /v4/channels )

• [Premium] إنشاء قناة ( POST /v4/channels )

• [Premium] Retrieve Channel ( GET /v4/channels/{channel_guid} )

• [Premium] Update Channel ( PATCH /v4/channels/{channel_guid} )

BSDS (المجالات القصيرة ذات العلامات التجارية)

وثائق المجالات القصيرة ذات العلامات التجارية

• استرداد BSDS ( GET /v4/bsds )

Webhooks

• [Premium] Get Webhooks ( GET /v4/organizations/{organization_guid}/webhooks )

• [Premium] إنشاء webhook ( POST /v4/webhooks )

• [Premium] استرداد webhook ( GET /v4/webhooks/{webhook_guid} )

• [Premium] قم بتحديث webhook ( POST /v4/webhooks/{webhook_guid )

• [Premium] حذف webhook ( DELETE /v4/webhooks/{webhook_guid} )

• [Premium] تحقق من webhook ( POST /v4/webhooks/{webhook_guid}/verify )

تخصيص طلبات HTTP

تأتي هذه الأحجار الكريمة مع عميل HTTP يمكنه استخدام محولات مختلفة. إنه يشحن مع محول Net::HTTP الذي يستخدمه افتراضيًا.

إذا كنت ترغب في التحكم في الاتصال ، فيمكنك إنشاء مثيلك الخاص من محول Net::HTTP وتمريره لخياراته لوكيل HTTP أو الخيارات التي تتحكم في الطلب. على سبيل المثال ، للتحكم في read_timeout يمكنك القيام بذلك:

 adapter = bitly :: http :: adapters :: nethttp.new (request_options: {read_timeout: 1}) : http_client ، الرمز المميز: رمز)

وبالمثل ، يمكنك استخدام وكيل HTTP مع المحول عن طريق تمرير متغيرات الوكيل إلى مُنشئ المحول.

 adapter = bitly :: http :: adapters :: nethttp.new (proxy_addr: "example.com" ، proxy_port: 80 ، proxy_user: "username" ، proxy_pass: "password") (محول) api_client = bitly :: api :: client.new (http: http_client ، رمز الرمز المميز: رمز)

بناء محول الخاص بك

إذا كنت تريد المزيد من التحكم في الطلب ، فيمكنك إنشاء محول خاص بك. يجب أن يحتوي محول HTTP داخل هذه الأحجار الكريمة على طريقة مثيل request يتلقى Bitly::HTTP::Request كائن وإرجاع مجموعة من أربعة كائنات:

1. رمز حالة الاستجابة

2. جسم الاستجابة كسلسلة

3. رؤوس الاستجابة باعتبارها تجزئة

4. منطقية تشير إلى ما إذا كان الرد نجاحًا أم لا

انظر ./src/bitly/http/adapters/net_http.rb للحصول على مثال.

تطوير

بعد التحقق من الريبو ، قم بتشغيل bin/setup لتثبيت التبعيات. ثم ، قم بتشغيل rake spec لتشغيل الاختبارات. يمكنك أيضًا تشغيل bin/console للحصول على مطالبة تفاعلية تتيح لك التجربة.

لتثبيت هذه الأحجار الكريمة على جهازك المحلي ، قم بتشغيل bundle exec rake install . لإصدار إصدار جديد ، قم بتحديث رقم الإصدار في version.rb ، ثم قم بتشغيل bundle exec rake release ، والذي سيقوم بإنشاء علامة GIT للإصدار ، و Push Git Commits و Tags ، ودفع ملف .gem إلى rubygems.org.

المساهمة

يتم الترحيب بتقارير الأخطاء وطلبات السحب على Github على https://github.com/philnash/bitly. يهدف هذا المشروع إلى أن يكون مساحة آمنة ومرحبة للتعاون ، ومن المتوقع أن يلتزم المساهمون بقواعد سلوك العهد المساهم.

رخصة

الجوهرة متوفرة كمصدر مفتوح بموجب شروط ترخيص معهد ماساتشوستس للتكنولوجيا.

مدونة لقواعد السلوك

من المتوقع أن يتبع كل من يتفاعل في قواعد الكود في مشروع BITLY ، وتتبع المشكلات ، وغرف الدردشة والقوائم البريدية مدونة قواعد السلوك.