العنوان الأساسي
أرسل كل طلب إلى هذا العنوان. أما 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/meThe workspace the credential belongs to, and for an OAuth token the member who approved it.
النطاقأي رمز وصول - GET
/public/v1/is-connectedCheck that the credential works.
النطاقأي رمز وصول - GET
/public/v1/groupsThe brands (customers) the credential can see.
النطاقأي رمز وصول - GET
/public/v1/countsPosts waiting for approval and unread open inbox conversations.
النطاقposts:readinbox:readالمُدخلاتquery: brandId?
Channels
- GET
/public/v1/integrationsThe connected channels, with their ids and networks.
النطاقposts:readالمُدخلاتquery: group? (a brand id) - GET
/public/v1/integration-settings/:idThe rules of a channel: character limits, media rules and the settings a post needs.
النطاقمفتاح API أو رمز وصول كامل - GET
/public/v1/find-slot/:idThe next free posting slot of a channel.
النطاقposts:read - GET
/public/v1/social/:integrationThe 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/:idDisconnect a channel.
النطاقمفتاح API أو رمز وصول كامل - POST
/public/v1/integration-trigger/:idRun a lookup a network offers (for example the playlists of a YouTube channel).
النطاقمفتاح API أو رمز وصول كاملالمُدخلاتbody: { methodName, data }
Posts
- GET
/public/v1/postsThe posts between two dates.
النطاقposts:readالمُدخلاتquery: startDate, endDate (ISO 8601), customer? - POST
/public/v1/postsCreate 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/settingsChange the network settings of a post.
النطاقمفتاح API أو رمز وصول كاملالمُدخلاتbody: { settings } - PUT
/public/v1/posts/:id/statusMove a post between draft and scheduled.
النطاقمفتاح API أو رمز وصول كاملالمُدخلاتbody: { status: draft|schedule } - GET
/public/v1/posts/:id/missingFor 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-idLink a post to the network post it became.
النطاقمفتاح API أو رمز وصول كاملالمُدخلاتbody: { releaseId } - DELETE
/public/v1/posts/:idDelete a post.
النطاقمفتاح API أو رمز وصول كامل - DELETE
/public/v1/posts/group/:groupDelete every post of a group (one post sent to several channels).
النطاقمفتاح API أو رمز وصول كامل
Media
- POST
/public/v1/uploadUpload a file to the media library.
النطاقmedia:writeالمُدخلاتmultipart: file, adjust? - POST
/public/v1/upload-from-urlAdd a file from a public https address.
النطاقmedia:writeالمُدخلاتbody: { url, adjust? } - GET
/public/v1/mediaThe media library, a page at a time.
النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: page?, search?, folder? - GET
/public/v1/media/:id/statusWhether an uploaded video finished processing.
النطاقمفتاح API أو رمز وصول كامل
Ideas
- POST
/public/v1/ideasSave an idea to the Ideas board.
النطاقideas:writeالمُدخلاتbody: { title, content? } - DELETE
/public/v1/ideas/:idRemove an idea the credential saved.
النطاقideas:write
Analytics
- GET
/public/v1/performanceA summary of the last 7 days: posts, reach and engagement.
النطاقanalytics:readالمُدخلاتquery: brandId?, tz? - GET
/public/v1/best-times/nextThe 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/:integrationThe analytics of a channel.
النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: date (days back) - GET
/public/v1/analytics/post/:postIdThe analytics of one published post.
النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: date (days back)
AI
- POST
/public/v1/ai/draftDraft a post about a web page with PostNimbo AI.
النطاقai:useالمُدخلاتbody: { url, title?, selection?, mode: summary|captions } - POST
/public/v1/ai/replyDraft a reply to a comment or message.
النطاقai:useالمُدخلاتbody: { text, url? }
Link in bio
- GET
/public/v1/link-in-bioThe link-in-bio pages of the workspace.
النطاقlink-in-bio:write - POST
/public/v1/link-in-bio/:id/linksAdd a link to a link-in-bio page.
النطاقlink-in-bio:writeالمُدخلاتbody: { label, url }
Video and clipping
- POST
/public/v1/generate-videoGenerate a video with one of the AI video tools.
النطاقمفتاح API أو رمز وصول كامل - POST
/public/v1/video/functionLoad the options of a video tool (voices, avatars).
النطاقمفتاح API أو رمز وصول كامل - POST
/public/v1/clippingCut a long video into short clips.
النطاقمفتاح API أو رمز وصول كامل - GET
/public/v1/clippingThe clipping jobs, a page at a time.
النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: page - GET
/public/v1/clipping/:idOne clipping job and its clips.
النطاقمفتاح API أو رمز وصول كامل
Notifications
- GET
/public/v1/notificationsThe workspace notifications, a page at a time.
النطاقمفتاح API أو رمز وصول كاملالمُدخلاتquery: page?
Webhooks
- GET
/public/v1/webhooks/eventsThe events a webhook is sent, with a sample payload of each.
النطاقأي رمز وصول - GET
/public/v1/webhooksThe webhooks of the workspace, without their addresses; ?url= finds the webhooks of one address.
النطاقwebhooks:writeالمُدخلاتquery: url? - POST
/public/v1/webhooksSubscribe 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/:idRemove a webhook (how a trigger switches off).
النطاقwebhooks:write
