বেস ঠিকানা
প্রতিটি রিকোয়েস্ট এই ঠিকানায় পাঠান। সেলফ-হোস্টেড 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 ফিল্ড থাকে।
রেট লিমিট
- প্রতিটি API কী বা টোকেনের জন্য মিনিটে 120টি রিকোয়েস্ট, সব রুট মিলিয়ে।
- পোস্ট তৈরিও প্রতি ওয়ার্কস্পেসে ঘণ্টায় সীমিত (ডিফল্ট 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
