وثائق المطورين

حزمة رسمية للـ TypeScript وأخرى لـ PHP. نفس العقد، نفس المسارات، نفس الصلاحيات التي يفحصها تطبيق قُرب نفسه.

TypeScript1.7.0PHP1.7

نظرة عامة

حزمة قُرب تعطيك مجتمعاً كاملاً عبر واجهة برمجية: منشورات، فعاليات، مدونات، ألبومات، مجموعات، مهام، تعليقات، إعجابات، أعضاء وصلاحيات — بالإضافة إلى تضمين المجتمع نفسه داخل موقعك.

الحزم

الفصل بينها مبني على سؤال واحد: من يُسمح له بحمل مفتاحك السري.

الحزمةتعمل فيتحمل المفتاحتُستخدم لـ
@gurb/serverNode 20+نعمقراءة مجتمعك والكتابة فيه، الأعضاء، إصدار جلسات التضمين
@gurb/embedالمتصفحأبداًعرض المجتمع أو قسم منه داخل صفحتك
@gurb/api-typesالاثنان—أنواع مشتركة
ts
import { createGurbClient } from '@gurb/server'

const gurb = createGurbClient({ apiKey: process.env.GURB_API_KEY! })

const community = await gurb.community.get()
const feed = await gurb.tweets.list({ limit: 20 })

await gurb.tweets.create({ content: 'أهلاً بالجميع 👋' })

المفتاح مثبّت على مجتمع واحد

ما فيه وسيط communityId في أي دالة. المفتاح نفسه يحمل المجتمع، فتسريبه يضر مجتمعاً واحداً ولا يمكن توجيهه لغيره.

الحزمتان متطابقتان على السلك

TypeScript وPHP مكتوبتان على عقد مسارات واحد وتتتبعان بعضهما نسخة بنسخة. الفرق بينهما شكل النداء فقط — اصطلاح لغة لا اختلاف في العقد.

php
$gurb = new Gurb\GurbClient(getenv('GURB_API_KEY'));

$community = $gurb->community->get();
$feed      = $gurb->tweets->list(limit: 20);

$gurb->tweets->create('أهلاً بالجميع 👋');