Por­tal-API

NFON bie­tet ein Ap­pli­ca­ti­on Pro­gramming In­ter­face (API) für das NFON Ad­min-Por­tal an. Das ist ei­ne sehr nütz­li­che Schnitt­stel­le und er­mög­licht die au­to­ma­ti­sier­te Ab­fra­ge und Kon­fi­gu­ra­ti­on ei­ner oder meh­re­rer NFON Cloud-Te­le­fon­an­la­gen. Denk­bar sind fol­gen­de An­wen­dungs­fäl­le:

Seit No­vem­ber 2025 ist die Nut­zung der API ein re­gu­lä­rer Ser­vice der NFON und un­ter­liegt nicht mehr den Ser­vice­ein­schrän­kun­gen ei­ner Be­ta-Ver­ein­ba­rung.

Ne­ben der Por­tal-API zur Kon­fi­gu­ra­ti­on bie­tet NFON auch ei­ne CTI-API für Call-Events an. Sie­he auch:

Auf­trag

Die Be­auf­tra­gung der API-Zu­gangs­da­ten er­folgt über:

Nach­dem das For­mu­lar aus­ge­füllt und ge­sen­det wur­de, er­hältst du die API-Zu­gangs­da­ten (API-Key & API-Se­cret) in ei­ner ver­schlüs­sel­ten Da­tei. Die Da­tei kann nur mit dem Sup­port-Pass­wort (frü­her: Sup­port-PIN) ent­schlüs­selt wer­den. Das Sup­port-Pass­wort ist im Ad­min-Por­tal 4 hin­ter­legt.

Do­ku­men­ta­ti­on

Die Do­ku­men­ta­ti­on ist über Git­Hub ver­füg­bar. Dort fin­det man die De­fi­ni­ti­on der API-End­points, der Au­then­ti­sie­rungs­me­tho­den, Bei­spie­le und Post­man Coll­ec­tions:

Up­dates

NFON mo­der­ni­siert das Ad­min-Por­tal und dem­nach wird auch die Por­tal-API ak­tua­li­siert. Über https://​sta​tus​.nfon​.com/ kann man sich über die Maß­nah­men in­for­mie­ren und sich für den News­let­ter (Sub­scri­be to up­dates) an­mel­den.

Wer nur Up­dates zur API abon­nie­ren möch­te, wählt in dem Sub­scri­be-For­mu­lar das The­ma “API Brea­king Ch­an­ges” aus.

Die ak­tu­el­len Ver­sio­nen des kann man über fol­gen­de URL aus­le­sen:

API-Pro­duk­te

Wer nicht die not­wen­di­gen Res­sour­cen oder Zeit für die Ein­ar­bei­tung in die NFON Por­tal-API hat, kann sich z.B. an die Fir­ma Frosch­häu­ser IT GmbH (https://​ecm​-en​gi​nee​ring​.eu/) wen­den. Die Soft­ware Por­tal­blitz (https://​nfon​tools​.de/) bie­tet vie­le nütz­li­che Werk­zeu­ge.

JSON

Das Da­ten­for­mat der NFON Por­tal-API ist die Ja­va­Script Ob­ject No­ta­ti­on (JSON).

JSON-Ele­men­te

Die NFON Por­tal-API ent­hält fol­gen­de JSON-Ele­men­te:

title
detail
described_by
href
offset
total
size
links
links [{rel, href},...]
data  [{name, value},...]
items [{href, links[], data[]}]

json2assoc

Bei­spiel aus der NFON Por­tal-API-Do­ku­men­ta­ti­on

JSON ist ein baum­ar­ti­ges Text­for­mat, das sich aus mei­ner Sicht schlecht wei­ter­ver­ar­bei­ten lässt. Da­her ha­be ich ein paar PHP-Skrip­te er­stellt, um JSON in ein as­so­zia­ti­ves Ar­ray zu wan­deln. Ein as­so­zia­ti­ves Ar­ray be­steht aus Schlüs­seln (en: keys) und den zu­ge­hö­ri­gen Wer­ten (en: va­lues).

Hier ein Bei­spiel für JSON:

{"href":"/api/customers/KCNU3/targets/phone-extensions/25/callforward-profiles",
"items":[
  {"href":"/api/customers/KCNU3/targets/phone-extensions/25/callforward-profiles/0",
  "links":[],
  "data":[
    {"name":"profileNumber","value":0},
    {"name":"profileName","value":"default"},
    {"name":"active","value":true},
    {"name":"immutable","value":true}
  ]}],
"links":null}

Und hier das dar­aus er­zeug­te as­so­zia­ti­ve Ar­ray:

array (
[href] => /api/customers/KCNU3/targets/phone-extensions/25/callforward-profiles
[items.0.href] => /api/customers/KCNU3/targets/phone-extensions/25/callforward-profiles/0
[items.0.data.profileNumber] => 0
[items.0.data.profileName] => default
[items.0.data.active] => 1
[items.0.data.immutable] => 1
[links] =>
)

Netz­ver­bin­der

Mei­ne ers­ten Er­fah­run­gen mit der NFON Por­tal-API ha­be ich mit PHP und MyS­QL um­ge­setzt: Netz­ver­bin­der

Schreibe einen Kommentar