सीधे कॉन्टेंट पर जाएं
डेवलपर

REST API रेफ़रेंस

/public/v1 के अंदर सब कुछ, सर्वर में असल में मौजूद रूट से बनाया गया। JSON अंदर, JSON बाहर।

बेस एड्रेस

हर रिक्वेस्ट इसी पते पर भेजें। सेल्फ़-होस्टेड PostNimbo इसकी जगह अपने बैकएंड का पता इस्तेमाल करता है।

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

ऑथेंटिकेशन

क्रेडेंशियल को Authorization हेडर में जैसा है वैसा ही डालें, Bearer प्रीफ़िक्स के बिना। दो तरह के क्रेडेंशियल चलते हैं:

  • API key, 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 key या टोकन के लिए एक मिनट में 120 रिक्वेस्ट, सभी रूट मिलाकर।
  • पोस्ट बनाने की सीमा हर वर्कस्पेस के लिए प्रति घंटा भी तय है (डिफ़ॉल्ट रूप से 90)।
  • सीमा पार होने पर जवाब 429 होता है, साथ में सेकंड में Retry-After हेडर। दोबारा कोशिश करने से पहले उतना इंतज़ार करें।

सेल्फ़-होस्टेड सर्वर PUBLIC_API_RATE_LIMIT, PUBLIC_API_RATE_TTL और API_LIMIT से अपनी सीमाएं खुद तय करते हैं।

एंडपॉइंट

स्कोप कॉलम बताता है कि OAuth टोकन को क्या चाहिए। API key हर रूट तक पहुंचती है।

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 key या फ़ुल-ऐक्सेस टोकन
  • 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 key या फ़ुल-ऐक्सेस टोकनइनपुटquery: refresh? (a channel id to reconnect)
  • DELETE/public/v1/integrations/:id

    Disconnect a channel.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकन
  • POST/public/v1/integration-trigger/:id

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

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकनइनपुट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 key या फ़ुल-ऐक्सेस टोकनइनपुटbody: { settings }
  • PUT/public/v1/posts/:id/status

    Move a post between draft and scheduled.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकनइनपुट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 key या फ़ुल-ऐक्सेस टोकन
  • PUT/public/v1/posts/:id/release-id

    Link a post to the network post it became.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकनइनपुटbody: { releaseId }
  • DELETE/public/v1/posts/:id

    Delete a post.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकन
  • DELETE/public/v1/posts/group/:group

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

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकन

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 key या फ़ुल-ऐक्सेस टोकनइनपुटquery: page?, search?, folder?
  • GET/public/v1/media/:id/status

    Whether an uploaded video finished processing.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकन

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 key या फ़ुल-ऐक्सेस टोकनइनपुटquery: date (days back)
  • GET/public/v1/analytics/post/:postId

    The analytics of one published post.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकनइनपुट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 key या फ़ुल-ऐक्सेस टोकन
  • POST/public/v1/video/function

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

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकन
  • POST/public/v1/clipping

    Cut a long video into short clips.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकन
  • GET/public/v1/clipping

    The clipping jobs, a page at a time.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकनइनपुटquery: page
  • GET/public/v1/clipping/:id

    One clipping job and its clips.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकन

Notifications

  • GET/public/v1/notifications

    The workspace notifications, a page at a time.

    स्कोपAPI key या फ़ुल-ऐक्सेस टोकनइनपुट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 में मदद करते हैं, डायरेक्टरी के लिए ऐप रिव्यू करते हैं और इंटीग्रेशन के लिए ज़रूरी एंडपॉइंट जोड़ते हैं।