כתובת בסיס
שלחו כל בקשה לכתובת הזו. PostNimbo באחסון עצמי משתמש בכתובת ה-backend שלו במקום.
https://postnimbo.com/api/public/v1
אימות
שימו את פרטי ההזדהות בכותרת Authorization כמו שהם, בלי הקידומת Bearer. שני סוגים עובדים:
- מפתח API, מ-הגדרות > סוכנים / 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.
נקודות קצה
עמודת ה-scope היא מה שטוקן 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
