Alamat dasar
Kirim setiap permintaan ke alamat ini. PostNimbo yang di-host sendiri menggunakan alamat backend-nya sendiri.
https://postnimbo.com/api/public/v1
Autentikasi
Masukkan kredensial ke header Authorization apa adanya, tanpa awalan Bearer. Ada dua jenis yang bisa dipakai:
- API key, dari Settings > Agents / Dev. Key ini bertindak sebagai seluruh workspace dan dapat mengakses setiap rute di bawah.
- Token akses OAuth (diawali pos_), dari aplikasi OAuth. Token ini bertindak sebagai anggota yang menyetujuinya, hanya melihat brand dan saluran milik anggota tersebut, dan terbatas pada scope yang mereka setujui.
curl https://postnimbo.com/api/public/v1/me \ -H "Authorization: <api key or pos_ token>"
Kredensial yang tidak ada atau salah menghasilkan 401. Rute yang tidak disetujui untuk sebuah token menghasilkan 403. Error menyertakan field msg atau message.
Batas permintaan
- 120 permintaan per menit untuk setiap API key atau token, di semua rute.
- Pembuatan postingan juga dibatasi per workspace setiap jam (default 90).
- Jika melewati batas, jawabannya 429 dengan header Retry-After dalam detik. Tunggu selama itu sebelum mencoba lagi.
Server yang di-host sendiri menetapkan batasnya sendiri dengan PUBLIC_API_RATE_LIMIT, PUBLIC_API_RATE_TTL, dan API_LIMIT.
Endpoint
Kolom scope menunjukkan apa yang dibutuhkan token OAuth. API key dapat mengakses setiap rute.
Account
- GET
/public/v1/meThe workspace the credential belongs to, and for an OAuth token the member who approved it.
CakupanToken apa pun - GET
/public/v1/is-connectedCheck that the credential works.
CakupanToken apa pun - GET
/public/v1/groupsThe brands (customers) the credential can see.
CakupanToken apa pun - GET
/public/v1/countsPosts waiting for approval and unread open inbox conversations.
Cakupanposts:readinbox:readInputquery: brandId?
Channels
- GET
/public/v1/integrationsThe connected channels, with their ids and networks.
Cakupanposts:readInputquery: group? (a brand id) - GET
/public/v1/integration-settings/:idThe rules of a channel: character limits, media rules and the settings a post needs.
CakupanAPI key atau token akses penuh - GET
/public/v1/find-slot/:idThe next free posting slot of a channel.
Cakupanposts:read - GET
/public/v1/social/:integrationThe sign-in link that connects a new channel of a network (for example linkedin).
CakupanAPI key atau token akses penuhInputquery: refresh? (a channel id to reconnect) - DELETE
/public/v1/integrations/:idDisconnect a channel.
CakupanAPI key atau token akses penuh - POST
/public/v1/integration-trigger/:idRun a lookup a network offers (for example the playlists of a YouTube channel).
CakupanAPI key atau token akses penuhInputbody: { methodName, data }
Posts
- GET
/public/v1/postsThe posts between two dates.
Cakupanposts:readInputquery: startDate, endDate (ISO 8601), customer? - POST
/public/v1/postsCreate a draft, schedule a post or publish now, on one or more channels.
Cakupanposts:scheduleInputbody: { 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.
CakupanAPI key atau token akses penuhInputbody: { settings } - PUT
/public/v1/posts/:id/statusMove a post between draft and scheduled.
CakupanAPI key atau token akses penuhInputbody: { 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.
CakupanAPI key atau token akses penuh - PUT
/public/v1/posts/:id/release-idLink a post to the network post it became.
CakupanAPI key atau token akses penuhInputbody: { releaseId } - DELETE
/public/v1/posts/:idDelete a post.
CakupanAPI key atau token akses penuh - DELETE
/public/v1/posts/group/:groupDelete every post of a group (one post sent to several channels).
CakupanAPI key atau token akses penuh
Media
- POST
/public/v1/uploadUpload a file to the media library.
Cakupanmedia:writeInputmultipart: file, adjust? - POST
/public/v1/upload-from-urlAdd a file from a public https address.
Cakupanmedia:writeInputbody: { url, adjust? } - GET
/public/v1/mediaThe media library, a page at a time.
CakupanAPI key atau token akses penuhInputquery: page?, search?, folder? - GET
/public/v1/media/:id/statusWhether an uploaded video finished processing.
CakupanAPI key atau token akses penuh
Ideas
- POST
/public/v1/ideasSave an idea to the Ideas board.
Cakupanideas:writeInputbody: { title, content? } - DELETE
/public/v1/ideas/:idRemove an idea the credential saved.
Cakupanideas:write
Analytics
- GET
/public/v1/performanceA summary of the last 7 days: posts, reach and engagement.
Cakupananalytics:readInputquery: brandId?, tz? - GET
/public/v1/best-times/nextThe next best times to post, from your own results.
Cakupanposts:readInputquery: integrationId?, brandId?, tz?, goal?: engagement|reach|views, count? (1-20) - GET
/public/v1/analytics/:integrationThe analytics of a channel.
CakupanAPI key atau token akses penuhInputquery: date (days back) - GET
/public/v1/analytics/post/:postIdThe analytics of one published post.
CakupanAPI key atau token akses penuhInputquery: date (days back)
AI
- POST
/public/v1/ai/draftDraft a post about a web page with PostNimbo AI.
Cakupanai:useInputbody: { url, title?, selection?, mode: summary|captions } - POST
/public/v1/ai/replyDraft a reply to a comment or message.
Cakupanai:useInputbody: { text, url? }
Link in bio
- GET
/public/v1/link-in-bioThe link-in-bio pages of the workspace.
Cakupanlink-in-bio:write - POST
/public/v1/link-in-bio/:id/linksAdd a link to a link-in-bio page.
Cakupanlink-in-bio:writeInputbody: { label, url }
Video and clipping
- POST
/public/v1/generate-videoGenerate a video with one of the AI video tools.
CakupanAPI key atau token akses penuh - POST
/public/v1/video/functionLoad the options of a video tool (voices, avatars).
CakupanAPI key atau token akses penuh - POST
/public/v1/clippingCut a long video into short clips.
CakupanAPI key atau token akses penuh - GET
/public/v1/clippingThe clipping jobs, a page at a time.
CakupanAPI key atau token akses penuhInputquery: page - GET
/public/v1/clipping/:idOne clipping job and its clips.
CakupanAPI key atau token akses penuh
Notifications
- GET
/public/v1/notificationsThe workspace notifications, a page at a time.
CakupanAPI key atau token akses penuhInputquery: page?
Webhooks
- GET
/public/v1/webhooks/eventsThe events a webhook is sent, with a sample payload of each.
CakupanToken apa pun - GET
/public/v1/webhooksThe webhooks of the workspace, without their addresses; ?url= finds the webhooks of one address.
Cakupanwebhooks:writeInputquery: url? - POST
/public/v1/webhooksSubscribe an address to events (how Zapier, Make and n8n triggers switch on).
Cakupanwebhooks:writeInputbody: { url, events?, integrations? (channel ids), name? } - DELETE
/public/v1/webhooks/:idRemove a webhook (how a trigger switches off).
Cakupanwebhooks:write
