Skip to main content
Use NiftyImages through Corsair: one client, typed API calls. The API key comes from the NiftyImages account. NiftyImages sells the Developer API on its Enterprise plan; a free or Starter account has no key. The plugin sends the key in the 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.list pages through every personalized image and countdown timer, images.stats reports opens over a window, and images.get and images.delete take the image’s URL.
  • Timers. timers.updateTargetDate moves a countdown timer’s deadline.
  • Data Store. store.fields lists the fields, store.addRecord adds a record or updates the one whose unique fields match, and store.deleteById and store.deleteRecord remove one.
  • Maps. maps.list, maps.get and maps.searchLocations read maps; maps.addLocation, maps.updateLocation and maps.deleteLocation change their locations, which NiftyImages geocodes in the background.
  • Photoshop images. psd.get lists the variables and layers, and psd.update edits layers by LayerName (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.
Things worth knowing:
  • Lists answer bare arrays. widgets.list sends [{ "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).
  • Opens is 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 as url.
  • 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.
What you get:
  • 27 typed API operations

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

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 images
Move a countdown timer
See the full list on the API page.

What’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.