مواد پر جائیں
ڈویلپرز

REST API ریفرنس

/public/v1 کے تحت سب کچھ، ان روٹس سے تیار کیا گیا جو سرور پر واقعی موجود ہیں۔ JSON اندر، JSON باہر۔

بنیادی ایڈریس

ہر درخواست اسی ایڈریس پر بھیجیں۔ سیلف ہوسٹڈ 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/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 کی یا مکمل رسائی والا ٹوکن
  • 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 کی یا مکمل رسائی والا ٹوکنان پٹquery: refresh? (a channel id to reconnect)
  • DELETE/public/v1/integrations/:id

    Disconnect a channel.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکن
  • POST/public/v1/integration-trigger/:id

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

    اسکوپAPI کی یا مکمل رسائی والا ٹوکنان پٹ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 کی یا مکمل رسائی والا ٹوکنان پٹbody: { settings }
  • PUT/public/v1/posts/:id/status

    Move a post between draft and scheduled.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکنان پٹ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 کی یا مکمل رسائی والا ٹوکن
  • PUT/public/v1/posts/:id/release-id

    Link a post to the network post it became.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکنان پٹbody: { releaseId }
  • DELETE/public/v1/posts/:id

    Delete a post.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکن
  • DELETE/public/v1/posts/group/:group

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

    اسکوپAPI کی یا مکمل رسائی والا ٹوکن

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 کی یا مکمل رسائی والا ٹوکنان پٹquery: page?, search?, folder?
  • GET/public/v1/media/:id/status

    Whether an uploaded video finished processing.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکن

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 کی یا مکمل رسائی والا ٹوکنان پٹquery: date (days back)
  • GET/public/v1/analytics/post/:postId

    The analytics of one published post.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکنان پٹ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 کی یا مکمل رسائی والا ٹوکن
  • POST/public/v1/video/function

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

    اسکوپAPI کی یا مکمل رسائی والا ٹوکن
  • POST/public/v1/clipping

    Cut a long video into short clips.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکن
  • GET/public/v1/clipping

    The clipping jobs, a page at a time.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکنان پٹquery: page
  • GET/public/v1/clipping/:id

    One clipping job and its clips.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکن

Notifications

  • GET/public/v1/notifications

    The workspace notifications, a page at a time.

    اسکوپAPI کی یا مکمل رسائی والا ٹوکنان پٹ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 میں مدد کرتے ہیں، ڈائریکٹری کے لیے ایپس کا جائزہ لیتے ہیں اور انٹیگریشنز کو درکار اینڈ پوائنٹس شامل کرتے ہیں۔