FTTX Demo Tutorial

Administration

API keys

Let another system look up ONUs or request a sync. Create a key, share the developer guide.

Who can use it: Super Admin, NOC Admin Open this page in the app
On this page

What this page is for #

An API key lets another computer system (your own CRM, a support tool, a mobile app's server) ask this app about ONUs without a person signing in. It can look up an ONU by serial or MAC and request a fresh sync.

API keys
API keys (example with sample data)
  1. 1 New key creates a key and its secret.
  2. 2 A key: its public ID, what it may do, and its limit of requests per minute. “Disable” pauses it; “Revoke” ends it for good.
  3. 3 Download PDF: the developer guide to hand to the programmer.
Sample data, not a real network. Tap a number or a line to match them; tap the picture to enlarge.

Create a key #

  1. Press New key.
  2. Give it a name that says who uses it (for example “Support portal”).
  3. Tick the abilities: onu.lookup to read, sync.request to ask for syncs. Set the rate limit.
  4. Save. The key (starts with ck_) and the secret (starts with sk_) are shown.
  5. Copy the secret now and send it to the developer by a safe channel, together with the PDF guide.

The developer guide #

The lower part of the page is a complete guide for programmers: how to authenticate, each endpoint with examples in cURL, PHP, Python and JavaScript, sample answers and error codes. Download PDF saves it as a file; Print prints it.

You do not need to understand it yourself: give the PDF and the key to the developer.

Good to know #

  • Give each outside system its own key. Then you can revoke one without breaking the others, and the sync logs show which key asked for what.
  • Requests started by a key run first in the sync queue.
  • The DCM billing system does not use these keys. It has its own signed connection: see Integrations.
  • Viewing this page needs “View API keys”; creating and revoking needs “Create / revoke API keys”.

Finished this topic?

Tick it off; the topic list shows what you have read.