Zum Inhalt springen
Entwickler

REST-API-Referenz

Alles unter /public/v1, erzeugt aus den Routen, die der Server tatsächlich hat. JSON rein, JSON raus.

Basisadresse

Senden Sie jede Anfrage an diese Adresse. Ein selbst gehostetes PostNimbo nutzt stattdessen seine eigene Backend-Adresse.

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

Authentifizierung

Setzen Sie die Zugangsdaten unverändert in den Authorization-Header, ohne Bearer-Präfix. Zwei Arten funktionieren:

  • Ein API-Schlüssel aus Einstellungen > Agenten / Dev. Er handelt als gesamter Workspace und erreicht jede Route unten.
  • Ein OAuth-Zugriffstoken (beginnt mit pos_) aus einer OAuth-App. Es handelt als das Mitglied, das es genehmigt hat, sieht nur dessen Marken und Kanäle und ist auf die genehmigten Scopes beschränkt.
curl https://postnimbo.com/api/public/v1/me \
  -H "Authorization: <api key or pos_ token>"

Fehlende oder falsche Zugangsdaten ergeben 401. Eine Route, für die ein Token nicht genehmigt wurde, ergibt 403. Fehler enthalten ein Feld msg oder message.

Rate Limits

  • 120 Anfragen pro Minute für jeden API-Schlüssel oder jedes Token, über alle Routen.
  • Das Erstellen von Beiträgen ist zusätzlich pro Workspace und Stunde begrenzt (standardmäßig 90).
  • Bei Überschreitung lautet die Antwort 429 mit einem Retry-After-Header in Sekunden. Warten Sie so lange, bevor Sie es erneut versuchen.

Selbst gehostete Server legen ihre eigenen Limits mit PUBLIC_API_RATE_LIMIT, PUBLIC_API_RATE_TTL und API_LIMIT fest.

Endpunkte

Die Spalte Scope zeigt, was ein OAuth-Token braucht. Ein API-Schlüssel erreicht jede Route.

Account

  • GET/public/v1/me

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

    ScopeJedes Token
  • GET/public/v1/is-connected

    Check that the credential works.

    ScopeJedes Token
  • GET/public/v1/groups

    The brands (customers) the credential can see.

    ScopeJedes Token
  • GET/public/v1/counts

    Posts waiting for approval and unread open inbox conversations.

    Scopeposts:readinbox:readEingabequery: brandId?

Channels

  • GET/public/v1/integrations

    The connected channels, with their ids and networks.

    Scopeposts:readEingabequery: 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.

    ScopeAPI-Schlüssel oder Token mit Vollzugriff
  • GET/public/v1/find-slot/:id

    The next free posting slot of a channel.

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

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

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: refresh? (a channel id to reconnect)
  • DELETE/public/v1/integrations/:id

    Disconnect a channel.

    ScopeAPI-Schlüssel oder Token mit Vollzugriff
  • POST/public/v1/integration-trigger/:id

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

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabebody: { methodName, data }

Posts

  • GET/public/v1/posts

    The posts between two dates.

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

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

    Scopeposts:scheduleEingabebody: { 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.

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabebody: { settings }
  • PUT/public/v1/posts/:id/status

    Move a post between draft and scheduled.

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabebody: { 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.

    ScopeAPI-Schlüssel oder Token mit Vollzugriff
  • PUT/public/v1/posts/:id/release-id

    Link a post to the network post it became.

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabebody: { releaseId }
  • DELETE/public/v1/posts/:id

    Delete a post.

    ScopeAPI-Schlüssel oder Token mit Vollzugriff
  • DELETE/public/v1/posts/group/:group

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

    ScopeAPI-Schlüssel oder Token mit Vollzugriff

Media

  • POST/public/v1/upload

    Upload a file to the media library.

    Scopemedia:writeEingabemultipart: file, adjust?
  • POST/public/v1/upload-from-url

    Add a file from a public https address.

    Scopemedia:writeEingabebody: { url, adjust? }
  • GET/public/v1/media

    The media library, a page at a time.

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: page?, search?, folder?
  • GET/public/v1/media/:id/status

    Whether an uploaded video finished processing.

    ScopeAPI-Schlüssel oder Token mit Vollzugriff

Ideas

  • POST/public/v1/ideas

    Save an idea to the Ideas board.

    Scopeideas:writeEingabebody: { title, content? }
  • DELETE/public/v1/ideas/:id

    Remove an idea the credential saved.

    Scopeideas:write

Analytics

  • GET/public/v1/performance

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

    Scopeanalytics:readEingabequery: brandId?, tz?
  • GET/public/v1/best-times/next

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

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

    The analytics of a channel.

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: date (days back)
  • GET/public/v1/analytics/post/:postId

    The analytics of one published post.

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: date (days back)

AI

  • POST/public/v1/ai/draft

    Draft a post about a web page with PostNimbo AI.

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

    Draft a reply to a comment or message.

    Scopeai:useEingabebody: { text, url? }

Link in bio

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

    The link-in-bio pages of the workspace.

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

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

    Scopelink-in-bio:writeEingabebody: { label, url }

Video and clipping

  • POST/public/v1/generate-video

    Generate a video with one of the AI video tools.

    ScopeAPI-Schlüssel oder Token mit Vollzugriff
  • POST/public/v1/video/function

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

    ScopeAPI-Schlüssel oder Token mit Vollzugriff
  • POST/public/v1/clipping

    Cut a long video into short clips.

    ScopeAPI-Schlüssel oder Token mit Vollzugriff
  • GET/public/v1/clipping

    The clipping jobs, a page at a time.

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: page
  • GET/public/v1/clipping/:id

    One clipping job and its clips.

    ScopeAPI-Schlüssel oder Token mit Vollzugriff

Notifications

  • GET/public/v1/notifications

    The workspace notifications, a page at a time.

    ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: page?

Webhooks

  • GET/public/v1/webhooks/events

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

    ScopeJedes Token
  • GET/public/v1/webhooks

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

    Scopewebhooks:writeEingabequery: url?
  • POST/public/v1/webhooks

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

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

    Remove a webhook (how a trigger switches off).

    Scopewebhooks:write

Sie bauen etwas mit PostNimbo?

Erzählen Sie uns, woran Sie arbeiten. Wir helfen bei der API, prüfen Apps für das Verzeichnis und ergänzen die Endpunkte, die Integrationen brauchen.