Skip to content
use case — api

The same actions, from your code.

liveEverything the team does by hand is an action with a name. Call it from TypeScript or Python, from a terminal or from an n8n flow — with a key that only does what you gave it.The SDKs, the CLI and the n8n node are generated from the same catalog the product runs on: one contract, four surfaces.

Modules involved: Platform

how it works

Step by step

  1. Issue a key

    Settings → Security. Each key lists the actions it can call; everything else is denied. Rotate or revoke without touching anyone's code.

    a key that does one thing
  2. Pick your surface

    npm: @vorluno/niiko-sdk. PyPI: niiko. Terminal: niiko-cli. n8n: n8n-nodes-niiko, in English and Spanish.

    your language, your tool
  3. Call an action

    Create a lead, log a call, move a deal, propose an invoice. Same validation, same permissions and same events as the screen.

    no second path
  4. Stay inside your caps

    Calls per minute and per day, and money per day, follow the plan. When you hit one you get a clear error, not a silent drop.

    predictable limits
what you need

Before you start

  • A workspace and an owner or admin to issue the key.
  • Node, Python, a terminal or n8n — whichever you already use.
plans

Every plan, with its caps: Free 30 calls a minute and 200 a day, with no money actions; paid plans raise both and open money actions. The exact numbers are on the pricing page.

Modules involvedPlatform

See the plans →

What it does NOT do yet

Said plainly

  • There's no webhooks screen yet: you poll or you subscribe from the client, not from a form in Settings.
  • The API exposes actions, not raw tables: if something isn't an action in the catalog, it isn't in the API either.
start

Read the reference

Every action, its parameters and its errors, in English, generated from the catalog.