მთავარ შინაარსზე გადასვლა
დეველოპერები

REST API-ის ცნობარი

ყველაფერი /public/v1-ის ქვეშ, გენერირებული იმ მარშრუტებიდან, რომლებიც სერვერს რეალურად აქვს. შესავალი JSON, გამომავალი JSON.

საბაზო მისამართი

ყველა მოთხოვნა ამ მისამართზე გაგზავნეთ. საკუთარ სერვერზე განთავსებული PostNimbo ამის ნაცვლად საკუთარ backend მისამართს იყენებს.

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

ავთენტიფიკაცია

ჩასვით მონაცემი Authorization სათაურში ისე, როგორც არის, Bearer პრეფიქსის გარეშე. მუშაობს ორი სახეობა:

  • API გასაღები, გვერდიდან პარამეტრები > აგენტები / Dev. ის მთელი სამუშაო სივრცის სახელით მოქმედებს და ქვემოთ მოცემულ ყველა მარშრუტზე წვდება.
  • OAuth წვდომის ტოკენი (იწყება pos_-ით), OAuth აპიდან. ის მოქმედებს იმ წევრის სახელით, ვინც დაამტკიცა, ხედავს მხოლოდ მის ბრენდებსა და არხებს და შეზღუდულია მის მიერ დამტკიცებული scope-ებით.
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 ცვლადებით აყენებენ.

Endpoint-ები

scope სვეტი აჩვენებს, რა სჭირდება 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-ში, ვამოწმებთ აპებს კატალოგისთვის და ვამატებთ endpoint-ებს, რომლებიც ინტეგრაციებს სჭირდება.