التخطي إلى المحتوى
المطوّرون

مرجع REST API

كل ما يقع تحت /public/v1، مولَّد من المسارات الموجودة فعلًا على الخادم. JSON للإدخال وJSON للإخراج.

العنوان الأساسي

أرسل كل طلب إلى هذا العنوان. أما PostNimbo المستضاف ذاتيًا فيستخدم عنوان الخادم الخلفي الخاص به.

https://postnimbo.com/api/public/v1

المصادقة

ضع بيانات الاعتماد في ترويسة Authorization كما هي، دون البادئة Bearer. يعمل نوعان:

  • مفتاح API، من Settings > Agents / Dev. يعمل باسم مساحة العمل بالكامل ويصل إلى كل المسارات أدناه.
  • رمز وصول OAuth (يبدأ بـ pos_)، من تطبيق OAuth. يعمل باسم العضو الذي وافق عليه، ولا يرى إلا علاماته التجارية وقنواته، ويقتصر على النطاقات التي وافق عليها.
curl https://postnimbo.com/api/public/v1/me \
  -H "Authorization: <api key or pos_ token>"

بيانات الاعتماد المفقودة أو الخاطئة تُرجع 401. والمسار الذي لم تتم الموافقة عليه للرمز يُرجع 403. تحمل الأخطاء حقل msg أو message.

حدود المعدّل

  • 120 طلبًا في الدقيقة لكل مفتاح API أو رمز وصول، على جميع المسارات.
  • إنشاء المنشورات محدود أيضًا لكل مساحة عمل في الساعة (90 افتراضيًا).
  • عند تجاوز الحد تكون الإجابة 429 مع ترويسة Retry-After بالثواني. انتظر هذه المدة قبل المحاولة مجددًا.

تضبط الخوادم المستضافة ذاتيًا حدودها الخاصة عبر PUBLIC_API_RATE_LIMIT وPUBLIC_API_RATE_TTL وAPI_LIMIT.

نقاط النهاية

عمود النطاق هو ما يحتاجه رمز OAuth. أما مفتاح API فيصل إلى كل المسارات.

Account

  • GET/public/v1/me

    The workspace the credential belongs to, and for an OAuth token the member who approved it.

    النطاقأي رمز وصول
  • GET/public/v1/is-connected

    Check that the credential works.

    النطاقأي رمز وصول
  • GET/public/v1/groups

    The brands (customers) the credential can see.

    النطاقأي رمز وصول
  • GET/public/v1/counts

    Posts waiting for approval and unread open inbox conversations.

    النطاقposts:readinbox:readالمُدخلاتquery: brandId?

Channels

  • GET/public/v1/integrations

    The connected channels, with their ids and networks.

    النطاقposts:readالمُدخلاتquery: group? (a brand id)
  • GET/public/v1/integration-settings/:id

    The rules of a channel: character limits, media rules and the settings a post needs.

    النطاقمفتاح API أو رمز وصول كامل
  • GET/public/v1/find-slot/:id

    The next free posting slot of a channel.

    النطاقposts:read
  • GET/public/v1/social/:integration

    The sign-in link that connects a new channel of a network (for example linkedin).

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: refresh? (a channel id to reconnect)
  • DELETE/public/v1/integrations/:id

    Disconnect a channel.

    النطاقمفتاح API أو رمز وصول كامل
  • POST/public/v1/integration-trigger/:id

    Run a lookup a network offers (for example the playlists of a YouTube channel).

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتbody: { methodName, data }

Posts

  • GET/public/v1/posts

    The posts between two dates.

    النطاقposts:readالمُدخلاتquery: startDate, endDate (ISO 8601), customer?
  • POST/public/v1/posts

    Create a draft, schedule a post or publish now, on one or more channels.

    النطاقposts:scheduleالمُدخلاتbody: { type: draft|schedule|now, date, shortLink, tags, posts: [{ integration: { id }, value: [{ content, image? }], settings? }] }
  • PUT/public/v1/posts/:id/settings

    Change the network settings of a post.

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتbody: { settings }
  • PUT/public/v1/posts/:id/status

    Move a post between draft and scheduled.

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتbody: { status: draft|schedule }
  • GET/public/v1/posts/:id/missing

    For a post the network accepted without returning its id: the recent posts of the channel to pick it from.

    النطاقمفتاح API أو رمز وصول كامل
  • PUT/public/v1/posts/:id/release-id

    Link a post to the network post it became.

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتbody: { releaseId }
  • DELETE/public/v1/posts/:id

    Delete a post.

    النطاقمفتاح API أو رمز وصول كامل
  • DELETE/public/v1/posts/group/:group

    Delete every post of a group (one post sent to several channels).

    النطاقمفتاح API أو رمز وصول كامل

Media

  • POST/public/v1/upload

    Upload a file to the media library.

    النطاقmedia:writeالمُدخلاتmultipart: file, adjust?
  • POST/public/v1/upload-from-url

    Add a file from a public https address.

    النطاقmedia:writeالمُدخلاتbody: { url, adjust? }
  • GET/public/v1/media

    The media library, a page at a time.

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: page?, search?, folder?
  • GET/public/v1/media/:id/status

    Whether an uploaded video finished processing.

    النطاقمفتاح API أو رمز وصول كامل

Ideas

  • POST/public/v1/ideas

    Save an idea to the Ideas board.

    النطاقideas:writeالمُدخلاتbody: { title, content? }
  • DELETE/public/v1/ideas/:id

    Remove an idea the credential saved.

    النطاقideas:write

Analytics

  • GET/public/v1/performance

    A summary of the last 7 days: posts, reach and engagement.

    النطاقanalytics:readالمُدخلاتquery: brandId?, tz?
  • GET/public/v1/best-times/next

    The next best times to post, from your own results.

    النطاقposts:readالمُدخلاتquery: integrationId?, brandId?, tz?, goal?: engagement|reach|views, count? (1-20)
  • GET/public/v1/analytics/:integration

    The analytics of a channel.

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: date (days back)
  • GET/public/v1/analytics/post/:postId

    The analytics of one published post.

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: date (days back)

AI

  • POST/public/v1/ai/draft

    Draft a post about a web page with PostNimbo AI.

    النطاقai:useالمُدخلاتbody: { url, title?, selection?, mode: summary|captions }
  • POST/public/v1/ai/reply

    Draft a reply to a comment or message.

    النطاقai:useالمُدخلاتbody: { text, url? }

Link in bio

  • GET/public/v1/link-in-bio

    The link-in-bio pages of the workspace.

    النطاقlink-in-bio:write
  • POST/public/v1/link-in-bio/:id/links

    Add a link to a link-in-bio page.

    النطاقlink-in-bio:writeالمُدخلاتbody: { label, url }

Video and clipping

  • POST/public/v1/generate-video

    Generate a video with one of the AI video tools.

    النطاقمفتاح API أو رمز وصول كامل
  • POST/public/v1/video/function

    Load the options of a video tool (voices, avatars).

    النطاقمفتاح API أو رمز وصول كامل
  • POST/public/v1/clipping

    Cut a long video into short clips.

    النطاقمفتاح API أو رمز وصول كامل
  • GET/public/v1/clipping

    The clipping jobs, a page at a time.

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: page
  • GET/public/v1/clipping/:id

    One clipping job and its clips.

    النطاقمفتاح API أو رمز وصول كامل

Notifications

  • GET/public/v1/notifications

    The workspace notifications, a page at a time.

    النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: page?

Webhooks

  • GET/public/v1/webhooks/events

    The events a webhook is sent, with a sample payload of each.

    النطاقأي رمز وصول
  • GET/public/v1/webhooks

    The webhooks of the workspace, without their addresses; ?url= finds the webhooks of one address.

    النطاقwebhooks:writeالمُدخلاتquery: url?
  • POST/public/v1/webhooks

    Subscribe an address to events (how Zapier, Make and n8n triggers switch on).

    النطاقwebhooks:writeالمُدخلاتbody: { url, events?, integrations? (channel ids), name? }
  • DELETE/public/v1/webhooks/:id

    Remove a webhook (how a trigger switches off).

    النطاقwebhooks:write

هل تبني شيئًا باستخدام PostNimbo؟

أخبرنا بما تعمل عليه. نساعدك في الـ API، ونراجع التطبيقات لإدراجها في الدليل، ونضيف نقاط النهاية التي تحتاجها عمليات التكامل.