HYSCORE|COCKPIT NUTZEROBERFLÄCHE FÜR DIE HYSCORE-SELBSTVERWALTUNG IM WEB DOKUMENTATION & HANDBUCH JANUAR 2019 API VERSION 3.51R2 - HYSCORE.IO
←
→
Transkription von Seiteninhalten
Wenn Ihr Browser die Seite nicht korrekt rendert, bitte, lesen Sie den Inhalt der Seite unten
hyScore|cockpit
Nutzeroberfläche
für die hyScore-Selbstverwaltung im Web
Dokumentation & Handbuch
Januar 2019
API Version 3.51r2
1
Inhaltsverzeichnis
HYSCORE|COCKPIT: REGISTRIERUNG & ANMELDUNG ................................................. 4
REGISTRIERUNG ...............................................................................................................................4
EMAIL-ADRESSE VERIFIZIEREN ...................................................................................................... 5
ANMELDUNG (LOGIN) ..................................................................................................................... 7
PASSWORT VERGESSEN (“FORGOT YOUR PASSWORD”) .............................................................8
SICHERHEITSCODE ..........................................................................................................................8
NEUES PASSWORT VERGEBEN ....................................................................................................... 9
HYSCORE|COCKPIT (ÜBERSICHT) ..................................................................................... 10
DAS MENÜ („FREE PLAN“- BZW. TESTVERSION)........................................................................ 11
DAS MENÜ (MIT VOLLEN NUTZERRECHTEN)............................................................................... 12
HYSCORE|ANALYZE ............................................................................................................... 13
API KEY MANAGEMENT (VERWALTUNG) ................................................................................... 13
EINSCHRÄNKUNGEN BEI „FREE PLAN“- UND TESTVERSION ............................................. 13
API-ZUGANGSSCHLÜSSEL (API KEY) ................................................................................. 13
FUNKTIONEN UND ICONS ...................................................................................................... 15
API KEY ERSTELLEN .............................................................................................................. 15
API KEY EDITIEREN ............................................................................................................... 16
API KEY DEAKTIVIEREN & AKTIVIEREN ............................................................................... 17
API KEY TESTEN..................................................................................................................... 18
API KEY-NUTZUNGSSTATISTIKEN (REPORT)...................................................................... 18
API KEY-PREIS(E) ................................................................................................................. 18
API-STATUS................................................................................................................................... 19
API-DOKUMENTATION ................................................................................................................ 20
NUTZUNGSSTATISTIKEN (REPORTS) ............................................................................................ 21
KOSTEN- UND API KEY-NUTZUNGSSTATISTIKEN IN ECHTZEIT ......................................... 21
TÄGLICHE NUTZUNG (DAILY USAGE) ................................................................................... 22
MONATLICHE NUTZUNG (MONTHLY USAGE) ..................................................................... 22
KOSTENKALKULATION ........................................................................................................... 22
KONTOEINSTELLUNGEN (ACCOUNT SETTINGS) ......................................................................... 24
PREISE (PRICING) ......................................................................................................................... 24
KONTO (ACCOUNT) .......................................................................................................................25
NUTZERVERWALTUNG & RECHTE (USER MANAGEMENT) ........................................................ 26
NEUEN BENUTZER EINRICHTEN ........................................................................................... 26
FUNKTIONEN FÜR NUTZER FREIGEBEN ODER ENTZIEHEN ................................................ 28
NUTZER DEAKTIVIEREN ......................................................................................................... 29
2
NUTZER AKTIVIEREN .............................................................................................................. 29
MEIN NUTZERPROFIL (MY USER PROFIL) .................................................................................. 30
PERSÖNLICHES PASSWORT ÄNDERN ......................................................................................... 30
SUPPORT TICKET ERSTELLEN (CREATE SUPPORT TICKET) ........................................................ 31
ÜBER HYSCORE.IO ................................................................................................................. 32
3
hyScore|cockpit: Registrierung & Anmeldung
Registrierung
Erstellen eines Nutzerkontos, um Zugriff auf einen hyScore|analyze API-
Zugangsschlüssel (API-Key) zu erhalten.
Registrierung unter folgendem Weblink: https://cockpit.hyscore.io/signup
Ihr Firmenname,
bei Einzelpersonen
bitte Ihren Namen
eingeben Passwort – min. 8
Zeichen, Groß- und
Kleinbuchstaben,
Zahlen,
Sonderzeichen
(!?#)
4
Nach der Eingabe der Informationen und Bestätigung der Allgemeinen
Geschäftsbedingungen („terms & condition“) sowie der Datenschutzrichtlinien
(„privacy policies“) erstellen Sie Ihr Nutzerkonto mit einem Klick auf „Create
Account“
Email-Adresse verifizieren
Sie werden aufgefordert, Ihre Email-Adresse zu verifizieren.
Wechseln Sie bitte dazu in Ihre Email-Anwendung, wie z.B. Outlook oder Gmail.
5
Sie sollten in Ihrem Posteingang eine Email mit dem Betreff: „hyScore says
„Thank You“: Please verify your email address“ finden.
Sollte die Verifizierungs-Email innerhalb von 2 Minuten nicht in Ihrem im
Posteingang vorfinden, überprüfen Sie bitte Ihren „Junk-Mail / Spam“
Ordner.
Beispiel Google Mail
Verifizieren Sie Ihre Email-Adresse mit einem Klick auf „Verify Email“.
Ihre Email-Adresse ist nun
verifiziert. Wechseln Sie zurück
zum Browser-Tab „hyScore.io:
Cockpit Self-Management“.
6
Anmeldung (Login)
Melden Sie sich nun mit Ihrer verifizierten Email-Adresse und dem von Ihnen
festgelegten Passwort unter dem Weblink https://cockpit.hyscore.io/login der
hyScore|cockpit Nutzeroberfläche an.
Nach erfolgreicher Anmeldung sehen Sie den Willkommensbildschirm der
hyScore|cockpit Nutzeroberfläche.
7
Passwort vergessen (“Forgot your password”)
Die wichtigste Funktion einer jeden Webapplikation! Sollten Sie Ihr Passwort für
den hyScore|cockpit Login vergessen haben, können Sie sich jederzeit ein neues
Passwort erstellen.
Klicken Sie hierzu auf „Forgot your password“ und geben Sie im folgenden
Nutzerdialog („Request Password Request“) Ihre verifizierte Email-Adresse an.
Sicherheitscode
Nach dem Klick auf die Schaltfläche „Reset Password“ wird eine Email von
support@hyscore.io mit dem Betreff „Your verification code“ und einem
Sicherheitscode an Ihre verifizierte Email-Adresse gesendet.
Bitte prüfen Sie Ihren „Junk-Mail / Spam“ – Ordner!
8
Neues Passwort vergeben
Geben Sie im nun folgenden Dialog Ihr neues Passwort ein und bestätigen Sie es
nochmals!
Bitte beachten Sie: das neue Passwort sollte min. 8 Zeichen lang sein und
aus Groß- und Kleinbuchstaben (Aa-Zz), sowie Zahlen (0-9) und
Sonderzeichen (!$+&) bestehen.
Vermeiden Sie bitte Passwörter wie zum Beispiel „APIneu1!“. Wir
empfehlen möglichst „kryptische“ Passwörter zu verwenden. Tipps zum
Erstellen von Passwörtern erhalten Sie unter anderem hier:
https://www.gdata.de/ratgeber/sichere-passwoerter
• Geben Sie bitte Ihre verifizierte Email-Adresse und Ihr neues Passwort ein.
• Bestätigen Sie nochmals Ihr Passwort.
• Geben Sie den per Email erhaltenen Verifizierungscode ein.
• Klicken Sie anschließend auf „Save new Password“.
Sie können sich nun mit Ihrer Emailadresse und Ihrem neuen Passwort an der
Nutzeroberfläche anmelden.
9
hyScore|cockpit (Übersicht)
Sie haben sich erfolgreich registriert und angemeldet. Herzlich Willkommen im
hyScore|cockpit!
Kontoname
Menü und
Navigation
Abmelden (Logout) Online-Chat
Support
10Das Menü („Free Plan“- bzw. Testversion)
Mobile Desktop
Ansicht Ansicht (Browser)
Produktauswahl
hyScore|analyze (default)
hy
Startseite
Schnittstellen-
Verwaltung (API-Key)
API-Status (allgemein)
Dokumentation
(im Web)
Nutzungsstatistiken
Kontoinformation
(Account)
Nutzerinformationen
Support-Ticket erstellen
Abmelden (Logout)
11Das Menü (mit vollen Nutzerrechten)
Mobile Desktop
Ansicht Ansicht (Browser)
Produktauswahl
hyScore|analyze (default)
hy
Startseite
Schnittstellen
Verwaltung (API-Key)
API Status (allgemein)
Dokumentation
Schnittstelle (einfach)
Nutzungsstatistiken
hyScore|analyze
Preiskonditionen
Kontoinformation
(Account)
Nutzerverwaltung
Nutzerinformationen
Support Ticket erstellen
Abmelden (Logout)
12hyScore|analyze
Cloud-basierte Text- und Sprachanalyse, die Inhalte aus jedweder Textquelle in
Echtzeit analysiert, bewertet und in einem strukturierten Ergebnis zur weiteren
Verwendung bereitstellt.
API Key Management (Verwaltung)
Einschränkungen bei „Free Plan“- und Testversion
Nach der erfolgreichen Registrierung und Anmeldung hat Ihr Nutzerkonto
automatisch den Kontostatus „Free Plan“- bzw. Testversion.
Damit haben Sie Zugriff auf einen API-Zugangsschlüssel (API Key) für Test- und
Evaluierungszwecke mit einem monatlichen Anfragekontingent (Request) von
10.000 Requests pro Monat.
Die Verwaltungsoptionen im Kontostatus „Free Plan“-, bzw. Testversion sind
eingeschränkt (siehe Abb. auf der nächsten Seite).
Sie können KEINE...
• zusätzlichen API-Zugangsschlüssel erstellen und konfigurieren.
• Limitierungen für das Anfrage (Request) – Volumen verändern
und einstellen, zum Beispiel von 10.000 / Monthly auf „Unlimited“.
API-Zugangsschlüssel (API Key)
Bei der erfolgreichen Registrierung Ihres
Nutzerkontos wurde automatisch der erste
API Key erstellt, der Ihnen unter API Key
Management zu Verfügung steht.
13API Key Management – Übersicht eines “Free Plan“- Nutzerkontos (oben) und eine mit mehreren
API Keys und freigeschalteten Funktionen (unten)
14Funktionen und Icons
In der API Key-Verwaltung (siehe Kapitel API-
Zugangsschlüssel (API Key)) finden sich die folgenden
Icons (Symbole) mit Funktionen:
API Key in die Zwischenablage kopieren
Nutzungsstatistiken für den gewählten API Key
Preise- und Konditionen für die variable Nutzung
API Key-Einstellungen editieren (Bezeichnung, Quota, etc.)
API Key deaktivieren
API Key aktivieren
API Key erstellen
Nicht im Free-Plan
Um einen zusätzlichen API Key zu erstellen, klicken Sie in der API Key-Übersicht
auf die Schaltfläche:
In der Übersicht erscheint nach einem kurzen Augenblick ein neuer API Key-
Eintrag mit der Bezeichnung - New Key. Sie können diesen API
Key direkt mit hyScore|analyze verwenden und die spezifischen Einstellungen via
(Editieren) vornehmen.
15API Key editieren
Nicht im Free-Plan
Nach dem Erstellen eines neuen API Keys können Sie diesen editieren und
folgende Einstellungen vornehmen:
Name / Bezeichnung
ändern
Notizen / Beschreibung
(Freitext)
Limit/Quota einstellen
API Key
Erstellt am (Datum)
Zuletzt aktualisiert
(Datum)
Konfigurieren Sie ein Quota/Limit
zur Kostenkontrolle und Sicherheit.
Wird das tägliche oder monatliche
Limit des API Keys erreicht,
bekommen Sie via API die
Statusmeldung „Limit exceeded“
(erreicht). Das Limit wird am
nächsten Tag/Monat auf den
eingestellten Wert zurückgesetzt.
Default-Wert: 10.000 Anfragen/Tag
16API Key deaktivieren & aktivieren
Nicht im Free-Plan
Mit einem Klick auf die Schaltfläche können Sie einen API Key dauerhaft
oder vorübergehend deaktivieren.
Die API lehnt alle ankommenden Anfragen sofort ab., so dass keine weiteren
Kosten für diesen API Key für Sie entstehen.
Mit einem Klick auf die Schaltfläche kann der API Key jederzeit wieder
aktiviert werden.
Das Löschen eines API Keys kann nur durch den hyScore Support
vorgenommen werden.
[DEACTIVATED]
kennzeichnet einen Mit einem Klick auf das
deaktivierten API Key. Icon kann der API Key
wieder AKTIVIERT
Anfragen werden werden.
geblockt.
17API Key testen
Siehe Anhang A: manueller Funktionstest eines API-Zugangsschlüssel (API Key)
mit z.B. Postman – Applikation für MacOS oder Windows.
API Key-Nutzungsstatistiken (Report)
Nutzungsstatistiken aller oder einzelner API-Zugangsschlüssel. Siehe Kapitel
Nutzungsstatistiken (Reports)
API Key-Preis(e)
Nicht im Free-Plan
Eine Übersicht der mit Ihnen vereinbarten Preise laut Servicevertrag. Siehe
Kapitel Preise (Pricing)
18API-Status
Allgemeine Zusammenfassung des Status des hyScore-Gesamtsystems über alle
Funktionalitäten der API-Schnittstellen und Analyseverfahren inkl.
Verarbeitungszeit und einer Verlaufsübersicht der Vorkommnisse der letzten
sieben Tage.
API response = durchschnittliche Antwortgeschwindigkeit der
API-Schnittstellen in Millisekunden (ms) –
ca. 50 (grün, perfekt) - 500 ms (grün, OK).
New URL analysis speed = durchschnittliche Analysegeschwindigkeit für
neue URL und Texte in Sekunden (s) –
Mittelwert ca. 1 Sekunde (grün, OK)
System live test = Alle Systemkomponenten arbeiten normal
(OK, 5, grün) bis Totalausfall (rot, fail, 0)
Error (last 7 days) = Ereignisse oder Vorfälle der letzten 7 Tage.
19API-Dokumentation
Über diesen Menüpunkt gelangen Sie zu unserer umfangreichen Dokumentation
der verschiedenen hyScore-Lösungen und -Produkte.
Sie finden dort die jeweils aktuellste Dokumentation unserer NLP-Lösungen:
• hyScore|analyze
• hyScore|search
• hyScore|sentiment
• hyScore|media
Des Weiteren finden Sie dort Themen wie z.B.:
• Best Practice
• Neueste Release Informationen
• Blog
• Häufig gestellte Fragen (FAQ)
• Anwendungsbeispiele (Use Cases)
• und mehr.
20Nutzungsstatistiken (Reports)
Kosten- und API Key-Nutzungsstatistiken in Echtzeit
Echtzeitauswertung der von Ihnen automatisch oder manuell durchgeführten API-
Anfragen (Requests) bzw. Analysen für den gewünschten Zeitraum.
Über das Dropdown-Menü lassen sich die Nutzungsstatistiken für ALLE oder
einen bestimmten API Key für den gewählten Zeitraum (im Beispiel: letzte 14
Tage) anzeigen.
21Tägliche Nutzung (Daily Usage)
Unter „Daily Usage“ haben Sie Zugriff auf die täglichen Nutzungsstatistiken der
von Ihnen verwendeten API Keys in Echtzeit.
In der Default-Ansicht wird Ihnen die Nutzung der letzten drei (3) Tage und die
aktuelle Nutzung für den aktuellen Tag angezeigt.
Optionen:
• Die letzten drei (3) Tage
• Die letzten sieben (7) Tage
• Die letzten vierzehn (14) Tage
• Diese Woche
• Diesen Monat (auf täglicher Basis)
Monatliche Nutzung (Monthly Usage)
Unter „Monthly Usage“ haben Sie Zugriff auf die monatlichen Nutzungsstatistiken
der von Ihnen verwendeten API Keys für die letzten 6 Monate.
In der Default-Ansicht wird Ihnen die Nutzung des aktuellen Monats angezeigt.
Optionen:
• Diesen Monat
• Die letzten (3) Monate
• Die letzten (6) Monate
Kostenkalkulation
Total Requests alle im gewählten Zeitraum durchgeführten API-
Anfragen (Requests) an hyScore-Lösungen.
Total Costs net ausschließlich Kosten (netto in EUR) der variablen
Nutzungsgebühren der hyScore-Lösungen.
Die monatliche technische Bereitstellungsgebühr, Entwickungs-, Service- und
Beratungsdienstleistungen, sowie etwaige zu berechnenden Lizenzkosten oder
sonstige Dienstleistungen, werden in diesen Reports nicht berücksichtigt.
Das Reporting dient zu einer Orientierung und Kostenkontrolle bei der Höhe der
variablen Kosten (pro 1.000 API-Anfragen), die im gewählten Zeitraum angefallen
sind. Die Kosten werden mit dem im Menüpunkt Pricing hinterlegten Konditionen
berechnet.
22Der Zugang zu Nutzungsstatistiken kann einzelnen Personen oder allen
anderen Kontonutzern vom Kontoeigentümer erteilt oder entzogen
werden. Siehe Kapitel „Nutzerverwaltung“ (User Management).
Sollten Sie historische Nutzungsstatistiken über einen Zeitraum der
letzten 6 Monate hinaus benötigen, wenden Sie sich bitte unter der
Email support@hyScore.io an unser Supportteam. Ihre Anfrage wird
entsprechend der Konditionen in der Servicevereinbarung vom
Stundenkontingent abgedeckt oder gemäß Stundensatz-Preisliste
berechnet.
23Kontoeinstellungen (Account Settings)
Die folgenden Menüpunkte dienen den Konto- und Profileinstellungen Ihres
Nutzerkontos.
Preise (Pricing)
Nicht im Free-Plan
Unter dem Menüpunkt „Pricing“ finden Sie die mit Ihnen im Servicevertrag
vereinbarten Preiskonditionen (netto in EUR) für die Bereitstellung der hyScore-
Lösung(en) und die anfallenden variablen Kosten pro 1.000 API-Anfragen (techn.
Kosten pro 1.000 API-Anfragen).
Die variablen Kosten und Volumengrenzen werden zur Berechnung der Total
Costs net in den Reports herangezogen.
Der Zugang zu den Preisinformationen kann einzelnen Personen oder
allen anderen Kontonutzern vom Kontoeigentümer erteilt oder entzogen
werden. Siehe Kapitel „Nutzerverwaltung“ (User Management).
24Konto (Account)
Unter dem Menüpunkt Account wird in der Regel Ihr Unternehmensname oder
Ihr Name (Einzelperson) verwendet, den Sie bei der erstmaligen Registrierung
eingegeben haben.
Bei Bedarf kann dieser mit einem Klick auf die Schaltfläche „Edit“ angepasst, bzw.
geändert werden.
Im Feld „Description“ (Beschreibung) können weitere Informationen hinterlegt
werden.
25Nutzerverwaltung & Rechte (User Management)
Nicht im Free-Plan
Die Nutzerverwaltung ermöglicht es Ihnen, zusätzliche Benutzer anzulegen und
Ihnen Zugriff auf alle oder nur ausgewählte Funktionen zu Ihrem Konto zu
ermöglichen.
Neuen Benutzer einrichten
Klicken Sie auf die Schaltfläche „Create User“ und geben Sie den Vor- und
Nachnamen, sowie die Email-Adresse des neuen Nutzers ein.
26Mit einem Klick auf die Schaltfläche „Save“ wird der neue Nutzer automatisch per
Email eingeladen und muss sich via der Funktion „Forgot Password“ (Passwort
vergessen) ein individuelles Passwort generieren.
Abb. der neue Nutzer ist nun angelegt.
27Funktionen für Nutzer freigeben oder entziehen
Als Default-Einstellung hat der neue Nutzer Zugriff auf folgende Funktionen:
• API Key Management - kann API-Zugangsschlüssel verwalten
• Reports (without Costs) - kann Nutzungsstatistiken ohne Kosten einsehen
Mit eine einem Klick auf die Schaltfläche (Editieren) neben dem jeweiligen
Nutzernamen können Funktionen und Berechtigungen erteilt oder entzogen
werden.
Derzeit mögliche Einstellungen:
• API Key Management - kann API-Zugangsschlüssel verwalten
• Pricing & Costs - kann Preise und Kosten sehen.
• Reports (without Costs) - kann Nutzungsstatistiken ohne Kosten einsehen
wenn „Pricing & Costs“ nicht aktiviert
• User Management - kann Nutzer verwalten / editieren.
28Nutzer deaktivieren
Mit einem Klick auf die Schaltfläche kann ein Nutzer „deaktiviert“
werden. Einmal deaktiviert kann der Nutzer sich nicht mehr am hyScore|cockpit
anmelden.
Nutzer aktivieren
Mit einem Klick auf die Schaltfläche kann ein Nutzer wieder „aktiviert“
werden und sich am hyScore|cockpit anmelden.
29Mein Nutzerprofil (My User Profil)
Im Menüpunkt „My User Profil“ haben Sie die Möglichkeit, Ihren Namen und/oder
Ihre Email-Adresse mit einem Klick auf die Schaltfläche „Edit“ zu ändern.
Persönliches Passwort ändern
Unter „Change Password“ können Sie Ihr derzeitiges Nutzerkonto-Passwort
ändern.
30Support Ticket erstellen (Create Support Ticket)
Unter „Create Support Ticket“
31Über hyScore.io
hyScore.io ist ein unabhängiger, branchenübergreifender Anbieter von Cloud-
basierten Natural Language Processing-Lösungen, kurz NLP. Das Berliner
Unternehmen nutzt seine flexible und einfach zu integrierende Technologie um
Inhalte (Texte, Websites, Audio/Video) in Echtzeit zu analysieren. Die auf künstlicher
Intelligenz basierende Technologie identifiziert und gewichtet relevante Inhalte
wie z.B. Keywords, Kategorien und Sentiment in Echtzeit. Die hyScore.io-Produkte
sind branchenübergreifend einsetzbar und können nach individuellen
Kundenanforderungen angepasst werden. Ein Team von erfahrenen Experten
unterstützt und berät die Kunden bezüglich des Einsatzes und der Anwendung
von NLP-Lösungen.
hyScore.io wurde im März 2017 von Michael Böcher, Lucas Hausmann und Cengiz
Kurt gegründet. Das Gründerteam verfügt über langjährige Erfahrung und
Expertise in der digitalen Wirtschaft und der Sprach- und Textanalyse. Namhafte
Investoren wie Martin Sinner und die VEMAG Verlags- und Medien AG, sowie
weitere Business Angels unterstützen das Unternehmen.
hyScore.io engagiert sich als eingetragenes Mitglied im Bundesverband der
Existenzgründer und im Bundesband Digitale Wirtschaft (BVDW).
Kontakt:
E-Mail: contact@hyscore.io
Adress:
hyScore.io GmbH
Reichenberger Str. 35
10999 Berlin, Germany
Web: https://hyscore.io
32Sie können auch lesen
