Skip to content

Update Widget API Docu #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spinetrak merged 2 commits into from
Sep 29, 2025
Merged

Update Widget API Docu #93

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
784496d
Update Widget API Docu to clarify the need for birthday as a paramete…
spinetrak Sep 29, 2025
da2521d
Fix Typo
spinetrak Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 28 additions & 18 deletions doc/widgetapi-userguide/widgetapi-userguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,37 +248,37 @@ Bei Javascript-Optionen vom Typ Zahl oder String können auch Funktionen verwend
<td>String</td>
<td>API Key (siehe Autorisierung)</td>
</tr>
<tr>
<tr valign="top">
<td>type</td>
<td>String</td>
<td>Auswahl der grafischen Darstellung:
graph: Netzwerk der Person bzw. der Firma
history: Historie (Timeline)
barChart: Balkendiagramm
sheet: tabellarische Darstellung der Bilanz/GuV
drillDown: Darstellung der Größe der wichtigsten Jahresabschlussposten als unterteiltes Rechteck
pubTable: Tabelle der neuesten Publikationen
dendrogram: Horizontale Baumdarstellung (auf northdata.de verwendet zur Darstellung der Publikationsgliederung)</td>
</tr>
<tr>
<ul><li>graph: Netzwerk der Person bzw. der Firma</li>
<li>history: Historie (Timeline)</li>
<li>barChart: Balkendiagramm</li>
<li>sheet: tabellarische Darstellung der Bilanz/GuV</li>
<li>drillDown: Darstellung der Größe der wichtigsten Jahresabschlussposten als unterteiltes Rechteck</li>
<li>pubTable: Tabelle der neuesten Publikationen</li>
<li>dendrogram: Horizontale Baumdarstellung (auf northdata.de verwendet zur Darstellung der Publikationsgliederung)</li></ul></td>
</tr>
<tr valign="top">
<td>language</td>
<td>String</td>
<td>Sprache
<br/>de: Deutsch (default)
<br/>en: Englisch (experimentell, wird ggf. noch nicht von allen Widgets unterstützt)
<td>Sprache<ul>
<li>de: Deutsch (default)</li>
<li>en: Englisch (experimentell, wird ggf. noch nicht von allen Widgets unterstützt)</li></ul></td>
</tr>
<tr>
<tr valign="top">
<td>domain</td>
<td>String</td>
<td>Typ des dargestellten Objekts (optional)
<br/>company: Firma (default)
<br/>person: Person
<br/>hrb: Handelsregisterbekanntmachung</td>
<ul><li>company: Firma (default)</li>
<li>person: Person (in diesem Fall ist zudem die Option birthday notwendig)</li>
<li>hrb: Handelsregisterbekanntmachung</li></ul></td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>Name des Objekts, z.B. Firmenname </td>
<td>Name des Objekts, z.B. Firmenname, bei Personen im Format "Nachname, Vorname"</td>
</tr>
<tr>
<td>address</td>
Expand All @@ -300,6 +300,11 @@ Hamburg</td>
<td>Handelsregister in der Form
HRA 12345</td>
</tr>
<tr>
<td>birthDay</td>
<td>String</td>
<td>Geburtstag im Format "YYYY-MM-TT" z.B. 1970-12-26</td>
</tr>
<tr>
<td>minHeight</td>
<td>Zahl</td>
Expand Down Expand Up @@ -345,6 +350,11 @@ Die Firma wird über die Konfigurationsoptionen `name`, `address`, `registerCity

3. Die Identifikation der Firma ist ansonsten weitgehend tolerant gegenüber verschiedenen Schreibweisen der Firma, früheren Namen/Orten, unterschiedlichen Schreibweisen des Orts, alten Formen des HR-Zeichen, etc.

### Personen-Identifikation

Eine Person wird über die Konfigurationsoptionen `name`, `address` und `birthDay` identifiziert.


### Autorisierung

Die Autorisierung erfolgt per API-Key (wie beim Daten-API), oder über die Freischaltung der Domain, wo die Widgets eingebunden werden. Um einen API-Key zu erhalten bzw. eine Domain freischalten zu lassen, wenden Sie sich bitte an North Data.
Expand Down