İçeriğe geç
Geliştiriciler

REST API referansı

/public/v1 altındaki her şey, sunucuda gerçekten bulunan rotalardan üretilir. JSON girer, JSON çıkar.

Temel adres

Her isteği bu adrese gönderin. Kendi sunucunuzda barındırılan bir PostNimbo bunun yerine kendi backend adresini kullanır.

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

Kimlik doğrulama

Kimlik bilgisini Authorization başlığına olduğu gibi, Bearer öneki olmadan koyun. İki tür çalışır:

  • Settings > Agents / Dev bölümünden alınan bir API anahtarı. Tüm çalışma alanı adına işlem yapar ve aşağıdaki tüm rotalara erişir.
  • Bir OAuth uygulamasından alınan OAuth erişim token'ı (pos_ ile başlar). Onu onaylayan üye adına işlem yapar, yalnızca o üyenin markalarını ve kanallarını görür ve onayladığı kapsamlarla sınırlıdır.
curl https://postnimbo.com/api/public/v1/me \
  -H "Authorization: <api key or pos_ token>"

Eksik veya hatalı bir kimlik bilgisi 401 döndürür. Token'ın onaylanmadığı bir rota 403 döndürür. Hatalar bir msg veya message alanı içerir.

Hız sınırları

  • Her API anahtarı veya token için tüm rotalarda toplam dakikada 120 istek.
  • Gönderi oluşturma ayrıca çalışma alanı başına saatlik olarak sınırlıdır (varsayılan olarak 90).
  • Sınır aşıldığında yanıt, saniye cinsinden Retry-After başlığıyla birlikte 429 olur. Tekrar denemeden önce o kadar bekleyin.

Kendi sunucusunda barındırılan kurulumlar kendi sınırlarını PUBLIC_API_RATE_LIMIT, PUBLIC_API_RATE_TTL ve API_LIMIT ile belirler.

Uç noktalar

Kapsam sütunu, bir OAuth token'ının neye ihtiyaç duyduğunu gösterir. Bir API anahtarı tüm rotalara erişir.

Account

  • GET/public/v1/me

    The workspace the credential belongs to, and for an OAuth token the member who approved it.

    KapsamHerhangi bir token
  • GET/public/v1/is-connected

    Check that the credential works.

    KapsamHerhangi bir token
  • GET/public/v1/groups

    The brands (customers) the credential can see.

    KapsamHerhangi bir token
  • GET/public/v1/counts

    Posts waiting for approval and unread open inbox conversations.

    Kapsamposts:readinbox:readGirdiquery: brandId?

Channels

  • GET/public/v1/integrations

    The connected channels, with their ids and networks.

    Kapsamposts:readGirdiquery: 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.

    KapsamAPI anahtarı veya tam erişimli token
  • GET/public/v1/find-slot/:id

    The next free posting slot of a channel.

    Kapsamposts:read
  • GET/public/v1/social/:integration

    The sign-in link that connects a new channel of a network (for example linkedin).

    KapsamAPI anahtarı veya tam erişimli tokenGirdiquery: refresh? (a channel id to reconnect)
  • DELETE/public/v1/integrations/:id

    Disconnect a channel.

    KapsamAPI anahtarı veya tam erişimli token
  • POST/public/v1/integration-trigger/:id

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

    KapsamAPI anahtarı veya tam erişimli tokenGirdibody: { methodName, data }

Posts

  • GET/public/v1/posts

    The posts between two dates.

    Kapsamposts:readGirdiquery: startDate, endDate (ISO 8601), customer?
  • POST/public/v1/posts

    Create a draft, schedule a post or publish now, on one or more channels.

    Kapsamposts:scheduleGirdibody: { 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.

    KapsamAPI anahtarı veya tam erişimli tokenGirdibody: { settings }
  • PUT/public/v1/posts/:id/status

    Move a post between draft and scheduled.

    KapsamAPI anahtarı veya tam erişimli tokenGirdibody: { 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.

    KapsamAPI anahtarı veya tam erişimli token
  • PUT/public/v1/posts/:id/release-id

    Link a post to the network post it became.

    KapsamAPI anahtarı veya tam erişimli tokenGirdibody: { releaseId }
  • DELETE/public/v1/posts/:id

    Delete a post.

    KapsamAPI anahtarı veya tam erişimli token
  • DELETE/public/v1/posts/group/:group

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

    KapsamAPI anahtarı veya tam erişimli token

Media

  • POST/public/v1/upload

    Upload a file to the media library.

    Kapsammedia:writeGirdimultipart: file, adjust?
  • POST/public/v1/upload-from-url

    Add a file from a public https address.

    Kapsammedia:writeGirdibody: { url, adjust? }
  • GET/public/v1/media

    The media library, a page at a time.

    KapsamAPI anahtarı veya tam erişimli tokenGirdiquery: page?, search?, folder?
  • GET/public/v1/media/:id/status

    Whether an uploaded video finished processing.

    KapsamAPI anahtarı veya tam erişimli token

Ideas

  • POST/public/v1/ideas

    Save an idea to the Ideas board.

    Kapsamideas:writeGirdibody: { title, content? }
  • DELETE/public/v1/ideas/:id

    Remove an idea the credential saved.

    Kapsamideas:write

Analytics

  • GET/public/v1/performance

    A summary of the last 7 days: posts, reach and engagement.

    Kapsamanalytics:readGirdiquery: brandId?, tz?
  • GET/public/v1/best-times/next

    The next best times to post, from your own results.

    Kapsamposts:readGirdiquery: integrationId?, brandId?, tz?, goal?: engagement|reach|views, count? (1-20)
  • GET/public/v1/analytics/:integration

    The analytics of a channel.

    KapsamAPI anahtarı veya tam erişimli tokenGirdiquery: date (days back)
  • GET/public/v1/analytics/post/:postId

    The analytics of one published post.

    KapsamAPI anahtarı veya tam erişimli tokenGirdiquery: date (days back)

AI

  • POST/public/v1/ai/draft

    Draft a post about a web page with PostNimbo AI.

    Kapsamai:useGirdibody: { url, title?, selection?, mode: summary|captions }
  • POST/public/v1/ai/reply

    Draft a reply to a comment or message.

    Kapsamai:useGirdibody: { text, url? }

Link in bio

  • GET/public/v1/link-in-bio

    The link-in-bio pages of the workspace.

    Kapsamlink-in-bio:write
  • POST/public/v1/link-in-bio/:id/links

    Add a link to a link-in-bio page.

    Kapsamlink-in-bio:writeGirdibody: { label, url }

Video and clipping

  • POST/public/v1/generate-video

    Generate a video with one of the AI video tools.

    KapsamAPI anahtarı veya tam erişimli token
  • POST/public/v1/video/function

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

    KapsamAPI anahtarı veya tam erişimli token
  • POST/public/v1/clipping

    Cut a long video into short clips.

    KapsamAPI anahtarı veya tam erişimli token
  • GET/public/v1/clipping

    The clipping jobs, a page at a time.

    KapsamAPI anahtarı veya tam erişimli tokenGirdiquery: page
  • GET/public/v1/clipping/:id

    One clipping job and its clips.

    KapsamAPI anahtarı veya tam erişimli token

Notifications

  • GET/public/v1/notifications

    The workspace notifications, a page at a time.

    KapsamAPI anahtarı veya tam erişimli tokenGirdiquery: page?

Webhooks

  • GET/public/v1/webhooks/events

    The events a webhook is sent, with a sample payload of each.

    KapsamHerhangi bir token
  • GET/public/v1/webhooks

    The webhooks of the workspace, without their addresses; ?url= finds the webhooks of one address.

    Kapsamwebhooks:writeGirdiquery: url?
  • POST/public/v1/webhooks

    Subscribe an address to events (how Zapier, Make and n8n triggers switch on).

    Kapsamwebhooks:writeGirdibody: { url, events?, integrations? (channel ids), name? }
  • DELETE/public/v1/webhooks/:id

    Remove a webhook (how a trigger switches off).

    Kapsamwebhooks:write

PostNimbo ile bir şey mi geliştiriyorsunuz?

Ne yaptığınızı bize anlatın. API konusunda yardımcı oluyor, dizin için uygulamaları inceliyor ve entegrasyonların ihtiyaç duyduğu uç noktaları ekliyoruz.