Por­tal-API

Das NFON Ap­pli­ca­ti­on Pro­gramming In­ter­face (API) für das NFON-Kon­fi­gu­ra­ti­ons­por­tal ist ein sehr nütz­li­ches “hid­den Fea­ture” 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:

• Be­stands­er­fas­sung (An­zahl Ne­ben­stel­len, End­ge­rä­te, Ruf­num­mern)
• Au­to­ma­ti­sier­te Kon­fi­gu­ra­ti­on von
  • Ne­ben­stel­len
  • Ruf­num­mern­zu­ord­nung
  • End­ge­rä­te­zu­ord­nung
  • Zen­tra­les Te­le­fon­buch
  • An­mel­dung an Queu­es oder Skills
  • Ruf­um­lei­tung
  • u.v.m.

NFON Ser­vice Por­tal Do­ku­men­ta­ti­on:

• https://​www​.nfon​.com/​e​n​/​s​e​r​v​i​c​e​/​d​o​c​u​m​e​n​t​a​t​i​o​n​/​m​a​n​u​a​l​s​/​s​e​r​v​i​c​e​p​o​r​t​a​l​api

NFON Ser­vice Por­tal API Usa­ge Ma­nu­al:

• https://​cdn2​.clou​dya​.com/​s​p​3​-​a​p​i​-​u​s​a​g​e​-​m​a​n​u​a​l​.​pdf

NFON Ser­vice Por­tal API Spe­ci­fi­ca­ti­on:

• https://​cdn2​.clou​dya​.com/​A​P​I​_​D​o​c​u​m​e​n​t​a​t​i​o​n​.​zip

Dein NFON-Ad­mi­nis­tra­tor kann bei dei­nem NFON ‑Part­ner die Zu­gangs­da­ten zur Por­tal-API an­for­dern. Da­zu muss dein Ad­min fol­gen­de Ein­ver­ständ­nis­er­klä­rung aus­fül­len:

• NFON Be­ta-Ver­ein­ba­rung

Ob der API-Zu­griff ak­tiv ist, kann man nur über ei­nen NFON C‑Account er­ken­nen. Das ne­ben­ste­hen­de Bild zeigt die Ei­gen­schaf­ten ei­ner K‑Anlage aus Sicht ei­nes Ope­ra­tors mit ei­nem C‑Account.

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.

Ak­tu­ell ar­bei­te ich an ei­nem Web-Ser­vice für den ein­fa­chen Zu­griff auf die NFON Por­tal-API:

• Netz­ver­bin­der

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

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] =>
)