Keys and the demo key
Each key belongs to your account and carries its plan. The Playground uses a demo key that answers for a small set of sample providers.
Create a key
- Sign in and open Keys in the dashboard.
- Choose Create key and name it after the system that will use it.
- Copy the key when it appears. We show it once.
Create one key for each service or environment, so you can revoke one without stopping the others.
Rotate and revoke
To rotate a key, create the new key, deploy it, then revoke the old key. A revoked key answers 401 unauthorized within a minute.
Limits for keys and accounts
The per-second limit applies to each key. The monthly call quota belongs to your account, and all its keys share it. The plan of your account sets both. Every lookup response tells you where you stand in its RateLimit-* and X-Quota-* headers. See Rate limits and quotas.
The demo key
The Playground sends your requests with a demo key that stays on our server. It answers only for the sample providers listed in the Playground, allows 20 requests a minute for each visitor, and does not include plan-to-provider search. Any other NPI answers 403 demo_restricted:
{ "type": "demo_restricted", "title": "Demo key restriction", "status": 403, "detail": "The playground key works only for the sample NPIs. Create a free key for any NPI.", "instance": "/api/v1/check", "request_id": "req_mW3y_sM0mgptQFPy", "docs": "https://inplan.io/docs/errors#demo_restricted", "sample_npis": [ "1376006148", "1427468453", "1306032347", "1538462239", "1629458435" ]}
A free key answers for any NPI, with 500 calls a month.