Getting Started – Wie fange ich an?

[Aalex]

Hallo zusammen,

ich habe vor, einen Electron (evtl sonstiger NodeJS) NaMi Client (mit Mailgun Integration, ähnlich eines PHP Projektes das es hier schon gibt) zu schreiben (und natürlich auch öffentlich zu machen sobald er benutzbar ist 😉 ).
Hierfür muss ich aber auf die Nami API zugreifen können, wie hier beschrieben. Den Benutzer habe ich angelegt (Nami Nr. 266465), allerdings ist auf der Seite nicht spezifiziert, wer denn die Systemadmins sind bzw. wie man diese erreicht.

Zusätzlich dazu wäre es natürlich super, wenn ich die Testumgebung (namitest.dpsg.de) nutzen könnte, um in meinem Stamm sicher nichts kaputt zu machen, leider scheint diese seit mindestens zwei Monaten unerreichbar zu sein (403 – Service Temporarily Unavailable).

Hätte ich einen API Benutzer, müsste ich mich an vorher beschriebener PHP Implementierung entlanghangeln, da alle Links auf konkrete Codebeispiele in der Dokumentation aus irgendeinem Grund einen Login benötigen (Sie z.B. Link unter „Systemverwaltung“ auf oben verlinkter doku.dpsg.de Seite) und die Java Doku unter nami.dpsg.de/apidocs/ nicht sehr aussagekräftig geschweige denn nützlich ist, da ich ja gar nicht wüsste, wo ich den Code zu dieser API finde, wodurch mir die Klassen- und Methodennamen da recht wenig bringen.

Tl;Dr:
Ich würde sehr gerne als Entwickler dazu beitragen, dass wir hier ein tolles Zusatzangebot an Software schreiben, leider habe ich keine Ahnung wo und wie ich beginnen soll und kann mir vorstellen, dass es auch anderen so ging, die dann aufgaben statt sich hier zu melden.
Ein sinnvolles Ergebnis hätte dieser Thread dann erzielt, wenn wir hier Schritte auflisten, wie genau man beginnen kann, was nötig ist und mögliche Stolperfallen, wie ich hier gelistet habe, gezielt auszuräumen und natürlich ich mit Entwickeln beginnen kann 😉

Liebe Grüße und Danke im Voraus
Aalex

• Dieses Thema wurde vor vor 6 Jahren, 1 Monat von Aalex bearbeitet. Grund: Links hinzugefügt

[Fabian]

Hallo Aalex,

Hierfür muss ich aber auf die Nami API zugreifen können, wie hier beschrieben. Den Benutzer habe ich angelegt (Nami Nr. 266465), allerdings ist auf der Seite nicht spezifiziert, wer denn die Systemadmins sind bzw. wie man diese erreicht.
Diese Dokumentation stammt vom Entwickler der Software. Wir verwenden in NaMi keine Systembenutzer für die API. Du kannst deinen normalen Benutzer verwenden, dieser ist automatisch für die API freigeschaltet.

Zusätzlich dazu wäre es natürlich super, wenn ich die Testumgebung (namitest.dpsg.de) nutzen könnte, um in meinem Stamm sicher nichts kaputt zu machen, leider scheint diese seit mindestens zwei Monaten unerreichbar zu sein (403 – Service Temporarily Unavailable).
Der Test-Server läuft leider seit dem letzten Software-Upgrade auf dem Server nicht mehr. Wir möchten diesen auch auf jeden Fall wieder zur Verfügung stellen, können aber gerade noch keine Zeitangabe angeben, wann er wieder verfügbar sein wird.

Hätte ich einen API Benutzer, müsste ich mich an vorher beschriebener PHP Implementierung entlanghangeln, da alle Links auf konkrete Codebeispiele in der Dokumentation aus irgendeinem Grund einen Login benötigen (Sie z.B. Link unter „Systemverwaltung“ auf oben verlinkter doku.dpsg.de Seite) und die Java Doku unter nami.dpsg.de/apidocs/ nicht sehr aussagekräftig geschweige denn nützlich ist, da ich ja gar nicht wüsste, wo ich den Code zu dieser API finde, wodurch mir die Klassen- und Methodennamen da recht wenig bringen.
Leider gibt es hier vom Hersteller nicht viel mehr Dokumentation. Auch wenn ich direkt beim Entwickler in der Doku schaue, finde ich nicht mehr Informationen. Ich habe mir einmal das PHP-Beispiel angeschaut. Ansonsten habe ich mir das meiste aber erarbeitet, indem ich NaMi im Firefox benutzt habe und gleichzeitig die Anfragen an den Server mit Firebug analysiert habe.

Als zusätzliche Quelle kann ich dich nur noch auf meine Versuche mit Java verweisen. Ansonsten findest du hier im Forum auch weitere Projekte in verschiedenen Sprachen, die NaMi-Nutzer selbst entwickelt haben.
https://github.com/fabianlipp/jnami

Ein sinnvolles Ergebnis hätte dieser Thread dann erzielt, wenn wir hier Schritte auflisten, wie genau man beginnen kann, was nötig ist und mögliche Stolperfallen, wie ich hier gelistet habe, gezielt auszuräumen und natürlich ich mit Entwickeln beginnen kann
Bei mir sind die ersten Schritte schon ein paar Jahre her. Ich könnte jetzt aus dem Stegreif nicht mehr sagen, wo man am besten anfängt. Aber wenn du ein paar Schritte weiter bist und Fragen hast, kann ich gerne probieren zu helfen.

Ich fände es auch gut, wenn wir eine einfache Anleitung für Einsteiger hätten. Die können wir dann bestimmt auch in die Doku aufnehmen.

Viele Grüße,
Fabian

[Aalex]

Hi Fabian,
erstmal danke für die Antwort. Wenn ich dich richtig verstehe bedeutet das, dass die Möglichkeit, einen System Benutzer anzulegen und diesem die Rechte zuzuweisen überhaupt nicht möglich ist? Zumindest habe ich jetzt nicht gefunden, wie ich dem Benutzer die Rechte geben soll, ohne ihn z.B. zum Leiter zu machen, wodurch er aber beitragspflichtig wäre.

Die Testumgebung wäre echt super, da sonst ein größeres Projekt, welches nicht nur Leserechte erfordert, schwierig zu entwickeln (da testen) ist.

Ich glaube das Hauptproblem liegt darin, dass auf doku.dpsg.de nirgends steht (zumindest nicht wo ich es gesehen hätte), dass dies nur allgemeine Infos zu diesem System sind und nicht zur Nami der DPSG im speziellen. Auch die vielen verlinkten Seiten, für die man sich anmelden müsste, sind mir ein Rätsel und entmutigen als Neuling sehr.

LG
Aalex

[Fabian]

Hi Aalex,

Wenn ich dich richtig verstehe bedeutet das, dass die Möglichkeit, einen System Benutzer anzulegen und diesem die Rechte zuzuweisen überhaupt nicht möglich ist? Zumindest habe ich jetzt nicht gefunden, wie ich dem Benutzer die Rechte geben soll, ohne ihn z.B. zum Leiter zu machen, wodurch er aber beitragspflichtig wäre.
Ja. Das liegt daran, dass diese Dokumentation vom Hersteller der Software übernommen ist. So wie wir NaMi in der DPSG einsetzen, ist das aber nicht vorgesehen. Für den Zugriff per API benutzt man auch immer seinen eigenen, personengebundenen Account.

Es gab auch mal die Überlegung eine andere Form des Zugriffs anzubieten (bei dem man z. B. eine einzelne Anwendung zum API-Zugriff autorisiert). So etwas ist bisher aber noch nicht implementiert.

Die Testumgebung wäre echt super, da sonst ein größeres Projekt, welches nicht nur Leserechte erfordert, schwierig zu entwickeln (da testen) ist.
Ja, vor dem Problem stand ich auch schon, da man halt (insbesondere schreibenden Zugriff) nicht auf dem Produktiv-System testen will. Ich hoffe auch, dass es da möglichst bald eine Lösung gibt.

Ich glaube das Hauptproblem liegt darin, dass auf doku.dpsg.de nirgends steht (zumindest nicht wo ich es gesehen hätte), dass dies nur allgemeine Infos zu diesem System sind und nicht zur Nami der DPSG im speziellen. Auch die vielen verlinkten Seiten, für die man sich anmelden müsste, sind mir ein Rätsel und entmutigen als Neuling sehr.
Ja, das sehe ich ein. Das könnte man echt mal benutzerfreundlicher machen. Und insgesamt ist die API leider auch vom Entwickler ziemlich schlecht dokumentiert. Ich schreib es mal mit auf die ToDo-Liste, kann aber auch keine Garantie geben, wann sich hier etwas tun kann.

Viele Grüße,
Fabian

[Autor]

Beiträge