Getting Started
Installation
NNIPA is a hosted, browser-based platform — there is no client to install for day-to-day use. This page covers what you actually need before getting started: browser requirements, network access for connecting your own data sources, and how to get credentials for programmatic access.
What you need
A modern browser
NNIPA runs entirely in the browser — the latest versions of Chrome, Edge, Firefox, or Safari all work. No plugins, and nothing to download for day-to-day use.
Network access for private sources
If you're connecting a database or setting up CDC behind a firewall or VPN, that source needs to accept inbound connections from NNIPA's ingestion network. See Connect Database and CDC for the specifics.
Credentials for programmatic access
Nothing to install for the API either — mint an API key or an OAuth client from Administration → API Keys and start making requests.
Connecting your own data sources
Uploading a file needs nothing beyond your browser. Connecting a live database or setting up Change Data Capture is a bit more involved, since NNIPA needs to reach a system that usually isn't exposed to the internet:
- Allowlist NNIPA's connection IPs on your database's firewall or security group.
- For CDC specifically, the source database needs logical replication (or the equivalent for its engine) enabled — see CDC for engine-specific requirements.
- REST and GraphQL API sources only need outbound access from NNIPA to the API endpoint — no inbound firewall changes required.
- There's nothing to install to try NNIPA — every feature described in these docs works the moment you have an account and, where relevant, at least one connected dataset.
- If your database can't accept inbound connections at all, file upload or a scheduled export into an already-connected source is a reasonable fallback while you sort out network access.