ApiKey header, one of the transports the docs allow, so it never appears in a URL a proxy would log.
What each group does:
- Images.
images.listpages through every personalized image and countdown timer,images.statsreports opens over a window, andimages.getandimages.deletetake the image’s URL. - Timers.
timers.updateTargetDatemoves a countdown timer’s deadline. - Data Store.
store.fieldslists the fields,store.addRecordadds a record or updates the one whose unique fields match, andstore.deleteByIdandstore.deleteRecordremove one. - Maps.
maps.list,maps.getandmaps.searchLocationsread maps;maps.addLocation,maps.updateLocationandmaps.deleteLocationchange their locations, which NiftyImages geocodes in the background. - Photoshop images.
psd.getlists the variables and layers, andpsd.updateedits layers byLayerName(text, colours, images, visibility). - Widgets and Bee Plugin. List widgets and their stats, users and images, and suspend or reinstate a widget or Bee Plugin user.
- Lists answer bare arrays.
widgets.listsends[{ "Name": "...", "WidgetKey": "..." }]with no envelope, so the plugin keys each list (widgets,images,fields,locations). A non-array body means an error rather than an empty page. - Property names are PascalCase, as sent:
WidgetKey,Impressions,CreateDate. Only the Data Store field list is lowercase (name,type,unique). Opensis a string in lists and a number on one image. Both are accepted.- Images, maps and Photoshop images are addressed by their image URL, e.g.
https://img1.niftyimages.com/p/lop/m7w, passed asurl. - Deletes, suspends and Data Store deletes answer an empty 200. The plugin reports
{ success: true }. - Every date is ISO 8601, e.g.
2016-03-12T08:00Z. Stats windows default to the last 30 days. - A user or recipient goes in the path, usually an email address, so the plugin percent-encodes it.
- A wrong path can answer an HTML page rather than JSON, which is reported as a path problem.
- 27 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the NiftyImages API key before the first call: More: API Key
pnpm corsair setup --plugin=niftyimages --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
Page through the account’s imagesWhat’s next
API reference
Every
niftyimages.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.