본문으로 건너뛰기
개발자

REST API 레퍼런스

/public/v1 아래의 모든 항목을 서버에 실제로 있는 경로에서 생성했습니다. JSON으로 보내고 JSON으로 받습니다.

기본 주소

모든 요청을 이 주소로 보내세요. 자체 호스팅 PostNimbo는 자체 백엔드 주소를 사용합니다.

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

인증

자격 증명을 Bearer 접두사 없이 그대로 Authorization 헤더에 넣으세요. 두 가지를 사용할 수 있습니다.

  • Settings > Agents / Dev에서 발급하는 API 키입니다. 워크스페이스 전체 권한으로 동작하며 아래 모든 경로에 접근할 수 있습니다.
  • OAuth 앱에서 발급하는 OAuth 액세스 토큰(pos_로 시작)입니다. 승인한 멤버의 권한으로 동작하고, 해당 멤버의 브랜드와 채널만 볼 수 있으며, 승인된 스코프로 제한됩니다.
curl https://postnimbo.com/api/public/v1/me \
  -H "Authorization: <api key or pos_ token>"

자격 증명이 없거나 잘못되면 401을 반환합니다. 토큰이 승인받지 않은 경로는 403을 반환합니다. 오류에는 msg 또는 message 필드가 포함됩니다.

요청 한도

  • API 키 또는 토큰마다 모든 경로를 합쳐 분당 120회 요청할 수 있습니다.
  • 게시물 생성은 워크스페이스별로 시간당 한도가 따로 있습니다(기본 90개).
  • 한도를 넘으면 초 단위 Retry-After 헤더와 함께 429를 반환합니다. 그 시간만큼 기다린 뒤 다시 시도하세요.

자체 호스팅 서버는 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 사용을 돕고, 디렉터리 등록용 앱을 검토하며, 연동에 필요한 엔드포인트를 추가합니다.