Adresse de base
Envoyez chaque requête à cette adresse. Une instance PostNimbo auto-hébergée utilise plutôt sa propre adresse de backend.
https://postnimbo.com/api/public/v1
Authentification
Placez l’identifiant tel quel dans l’en-tête Authorization, sans préfixe Bearer. Deux types fonctionnent :
- Une clé API, depuis Paramètres > Agents / Dev. Elle agit au nom de tout l’espace de travail et accède à toutes les routes ci-dessous.
- Un jeton d’accès OAuth (il commence par pos_), issu d’une application OAuth. Il agit au nom du membre qui l’a approuvé, ne voit que ses marques et ses canaux, et se limite aux scopes approuvés.
curl https://postnimbo.com/api/public/v1/me \ -H "Authorization: <api key or pos_ token>"
Un identifiant manquant ou incorrect renvoie 401. Une route pour laquelle un jeton n’a pas été approuvé renvoie 403. Les erreurs contiennent un champ msg ou message.
Limites de débit
- 120 requêtes par minute pour chaque clé API ou jeton, toutes routes confondues.
- La création de publications est aussi limitée par espace de travail et par heure (90 par défaut).
- Au-delà d’une limite, la réponse est 429 avec un en-tête Retry-After en secondes. Attendez ce délai avant de réessayer.
Les serveurs auto-hébergés définissent leurs propres limites avec PUBLIC_API_RATE_LIMIT, PUBLIC_API_RATE_TTL et API_LIMIT.
Endpoints
La colonne Scope indique ce dont un jeton OAuth a besoin. Une clé API accède à toutes les routes.
Account
- GET
/public/v1/meThe workspace the credential belongs to, and for an OAuth token the member who approved it.
PortéeN’importe quel jeton - GET
/public/v1/is-connectedCheck that the credential works.
PortéeN’importe quel jeton - GET
/public/v1/groupsThe brands (customers) the credential can see.
PortéeN’importe quel jeton - GET
/public/v1/countsPosts waiting for approval and unread open inbox conversations.
Portéeposts:readinbox:readEntréequery: brandId?
Channels
- GET
/public/v1/integrationsThe connected channels, with their ids and networks.
Portéeposts:readEntréequery: group? (a brand id) - GET
/public/v1/integration-settings/:idThe rules of a channel: character limits, media rules and the settings a post needs.
PortéeClé API ou jeton à accès complet - GET
/public/v1/find-slot/:idThe next free posting slot of a channel.
Portéeposts:read - GET
/public/v1/social/:integrationThe sign-in link that connects a new channel of a network (for example linkedin).
PortéeClé API ou jeton à accès completEntréequery: refresh? (a channel id to reconnect) - DELETE
/public/v1/integrations/:idDisconnect a channel.
PortéeClé API ou jeton à accès complet - POST
/public/v1/integration-trigger/:idRun a lookup a network offers (for example the playlists of a YouTube channel).
PortéeClé API ou jeton à accès completEntréebody: { methodName, data }
Posts
- GET
/public/v1/postsThe posts between two dates.
Portéeposts:readEntréequery: startDate, endDate (ISO 8601), customer? - POST
/public/v1/postsCreate a draft, schedule a post or publish now, on one or more channels.
Portéeposts:scheduleEntréebody: { type: draft|schedule|now, date, shortLink, tags, posts: [{ integration: { id }, value: [{ content, image? }], settings? }] } - PUT
/public/v1/posts/:id/settingsChange the network settings of a post.
PortéeClé API ou jeton à accès completEntréebody: { settings } - PUT
/public/v1/posts/:id/statusMove a post between draft and scheduled.
PortéeClé API ou jeton à accès completEntréebody: { status: draft|schedule } - GET
/public/v1/posts/:id/missingFor a post the network accepted without returning its id: the recent posts of the channel to pick it from.
PortéeClé API ou jeton à accès complet - PUT
/public/v1/posts/:id/release-idLink a post to the network post it became.
PortéeClé API ou jeton à accès completEntréebody: { releaseId } - DELETE
/public/v1/posts/:idDelete a post.
PortéeClé API ou jeton à accès complet - DELETE
/public/v1/posts/group/:groupDelete every post of a group (one post sent to several channels).
PortéeClé API ou jeton à accès complet
Media
- POST
/public/v1/uploadUpload a file to the media library.
Portéemedia:writeEntréemultipart: file, adjust? - POST
/public/v1/upload-from-urlAdd a file from a public https address.
Portéemedia:writeEntréebody: { url, adjust? } - GET
/public/v1/mediaThe media library, a page at a time.
PortéeClé API ou jeton à accès completEntréequery: page?, search?, folder? - GET
/public/v1/media/:id/statusWhether an uploaded video finished processing.
PortéeClé API ou jeton à accès complet
Ideas
- POST
/public/v1/ideasSave an idea to the Ideas board.
Portéeideas:writeEntréebody: { title, content? } - DELETE
/public/v1/ideas/:idRemove an idea the credential saved.
Portéeideas:write
Analytics
- GET
/public/v1/performanceA summary of the last 7 days: posts, reach and engagement.
Portéeanalytics:readEntréequery: brandId?, tz? - GET
/public/v1/best-times/nextThe next best times to post, from your own results.
Portéeposts:readEntréequery: integrationId?, brandId?, tz?, goal?: engagement|reach|views, count? (1-20) - GET
/public/v1/analytics/:integrationThe analytics of a channel.
PortéeClé API ou jeton à accès completEntréequery: date (days back) - GET
/public/v1/analytics/post/:postIdThe analytics of one published post.
PortéeClé API ou jeton à accès completEntréequery: date (days back)
AI
- POST
/public/v1/ai/draftDraft a post about a web page with PostNimbo AI.
Portéeai:useEntréebody: { url, title?, selection?, mode: summary|captions } - POST
/public/v1/ai/replyDraft a reply to a comment or message.
Portéeai:useEntréebody: { text, url? }
Link in bio
- GET
/public/v1/link-in-bioThe link-in-bio pages of the workspace.
Portéelink-in-bio:write - POST
/public/v1/link-in-bio/:id/linksAdd a link to a link-in-bio page.
Portéelink-in-bio:writeEntréebody: { label, url }
Video and clipping
- POST
/public/v1/generate-videoGenerate a video with one of the AI video tools.
PortéeClé API ou jeton à accès complet - POST
/public/v1/video/functionLoad the options of a video tool (voices, avatars).
PortéeClé API ou jeton à accès complet - POST
/public/v1/clippingCut a long video into short clips.
PortéeClé API ou jeton à accès complet - GET
/public/v1/clippingThe clipping jobs, a page at a time.
PortéeClé API ou jeton à accès completEntréequery: page - GET
/public/v1/clipping/:idOne clipping job and its clips.
PortéeClé API ou jeton à accès complet
Notifications
- GET
/public/v1/notificationsThe workspace notifications, a page at a time.
PortéeClé API ou jeton à accès completEntréequery: page?
Webhooks
- GET
/public/v1/webhooks/eventsThe events a webhook is sent, with a sample payload of each.
PortéeN’importe quel jeton - GET
/public/v1/webhooksThe webhooks of the workspace, without their addresses; ?url= finds the webhooks of one address.
Portéewebhooks:writeEntréequery: url? - POST
/public/v1/webhooksSubscribe an address to events (how Zapier, Make and n8n triggers switch on).
Portéewebhooks:writeEntréebody: { url, events?, integrations? (channel ids), name? } - DELETE
/public/v1/webhooks/:idRemove a webhook (how a trigger switches off).
Portéewebhooks:write
