Eduframe

Eduframe ist eine Komplettlösung für kommerzielle Schulungsanbieter & Business Schools, um mehr Schüler zu gewinnen, die Kursverwaltung zu verwalten und zu automatisieren und die ultimative Lernerfahrung zu bieten. Eduframe lässt sich nahtlos in Canvas LMS integrieren. Der Connector eröffnet die Möglichkeit, Ihre vorhandenen Softwareanwendungen wie Ihre CRM- und Buchhaltungssoftware einfach in Eduframe zu integrieren.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Copilot Studio	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)

Kontakt
Name	Eduframe-Entwicklungsteam
URL	https://eduframe.co
Email	dev@drieam.nl

Connectormetadaten
Herausgeber	Microsoft
Webseite	https://eduframe.co
Datenschutzrichtlinie	https://drieam.com/security-and-privacy/
Kategorien	Daten

Eduframe verwaltet und automatisiert die Kursverwaltung für kommerzielle Schulungsanbieter und Business Schools. Mithilfe dieses Connectors können verschiedene Tools mit Eduframe verbunden werden, um Kurse, Benutzer, Rechnungen und vieles mehr automatisch zu verwalten.

Voraussetzungen

Um diesen Connector zu verwenden, benötigen Sie eine Eduframe-Lizenz. Weitere Informationen zu Eduframe und zum Abrufen einer Lizenz finden Sie hier.

Wenn Sie bereits über eine Eduframe-Lizenz verfügen, stellen Sie sicher, dass Azure Logic Apps für Ihre Umgebung aktiviert sind. Wenn Sie diese Integration aktivieren möchten, können Sie eine E-Mail senden support@eduframe.nl.

So erhalten Sie Anmeldeinformationen

Wenn Sie diesen Connector zum ersten Mal verwenden, werden Sie aufgefordert, sich bei Eduframe anzumelden und diesen Connector zu autorisieren. Nach der Autorisierung können Sie diesen Connector und alle zugehörigen Features verwenden.

Erste Schritte mit Ihrem Connector

Eduframe stellt Webhooks bereit, die als Trigger für Ihre Automatisierungen fungieren. Wir können einen neuen Fluss erstellen, der jedes Mal ausgelöst wird, wenn ein neuer Benutzer zu Eduframe hinzugefügt wird. Beim Erstellen eines neuen Flusses können Sie diesen Connector auswählen und als Trigger "Webhook abonnieren" auswählen. Wählen Sie dann unter "events Item" die Option "user.created" aus. Sie können mehr hinzufügen, aber jetzt sind wir nur an diesem Interessierten interessiert.

Als Nächstes möchten wir wissen, welcher Benutzer eduframe hinzugefügt wurde. Dazu können wir einen neuen Schritt aus diesem Connector mit dem Namen "Benutzer abrufen" hinzufügen. Für diesen Schritt ist eine ID eines Benutzers erforderlich. Wir können die Entitäts-ID aus dem Webhook verwenden.

Da wir nun wissen, wer der neue Benutzer in Eduframe ist, können wir diese Person per E-Mail senden. Als Beispiel verwenden wir den Outlook-Connector, dies kann jedoch ein beliebiger E-Mail-Anbieter sein. Fügen Sie einen neuen Schritt hinzu, und wählen Sie "E-Mail senden" aus. Hier können wir die E-Mail des Benutzers, einen Betreff und die E-Mail ausfüllen, die wir senden möchten. Beachten Sie, dass Sie im Textkörper der E-Mail andere Attribute des Benutzers verwenden können, z. B. den Vornamen und den Nachnamen.

Wenn wir mit dem Schreiben der E-Mail fertig sind, können wir diesen Fluss speichern. Jedes Mal, wenn ein neuer Benutzer zu Eduframe hinzugefügt wird, erhält diese Person eine Willkommens-E-Mail.

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abrufen aller Katalogvarianten	Ruft alle Katalogvarianten ab.
Abrufen der Authentifizierungen eines Benutzers	Ruft eine Liste der Authentifizierungen ab, die zu einem bestimmten Benutzer gehören.
Abrufen einer Kategorie	Abrufen einer Kategorie nach ID
Abrufen einer Rechnung	Rufen Sie eine einzelne Rechnung nach ID ab.
Abrufen eines Benutzers	Rufen Sie einen einzelnen Benutzer anhand der ID ab.
Abrufen eines Kontos	Rufen Sie ein Konto nach ID ab.
Alle Benutzer auflisten	Ruft alle Benutzer ab.
Alle Bezeichnungen auflisten	Rufen Sie alle Bezeichnungen ab.
Alle Kategorien auflisten	Ruft alle Kategorien ab.
Alle Konten auflisten	Ruft alle Konten ab.
Alle Kurse auflisten	Erhalten Sie alle Kurse.
Alle Rechnungen auflisten	Rufen Sie alle Rechnungen ab.
Alle Rechnungssteuersätze auflisten	Abrufen aller Rechnungssteuersätze
Hinzufügen einer Authentifizierung	Hinzufügen einer Authentifizierungsmethode zu einem vorhandenen Benutzer
Hinzufügen einer Rechnung	Fügen Sie Ihrer Administration eine Rechnung hinzu.
Hinzufügen einer Rechnungssteuer	Fügen Sie eine Rechnungssteuer hinzu, die auf der Rechnung verwendet werden kann.
Hinzufügen eines Benutzers	Fügen Sie Ihrer Verwaltung einen Benutzer hinzu.
Hinzufügen eines Kontos	Fügen Sie Ihrer Administration ein Konto hinzu.
Hinzufügen eines Kurses	Fügen Sie Ihrer Verwaltung einen Kurs hinzu.
Kategorie hinzufügen	Fügen Sie Ihrer Verwaltung eine Kategorie hinzu.
Kurs abrufen	Abrufen eines einzelnen Kurses nach ID
Löschen einer Authentifizierung eines Benutzers	Löschen Sie eine der Authentifizierungen eines Benutzers. Beachten Sie, dass Sie die letzte Authentifizierung nicht löschen können!

Abrufen aller Katalogvarianten

Vorgangs-ID:: Get_catalog_variants

Ruft alle Katalogvarianten ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Seitenzahl	page		integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	per_page		integer	Anzahl der Datensätze pro Seite.

Gibt zurück

response: array of catalog_variant

Abrufen der Authentifizierungen eines Benutzers

Vorgangs-ID:: Get_authentications_by_user_id

Ruft eine Liste der Authentifizierungen ab, die zu einem bestimmten Benutzer gehören.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Seitenzahl	page		integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	per_page		integer	Anzahl der Datensätze pro Seite.
Benutzer-ID	user_id	True	integer	Bezeichner des Benutzers.

Gibt zurück

response: array of authentication

Abrufen einer Kategorie

Vorgangs-ID:: Get_categories_id

Abrufen einer Kategorie nach ID

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kategorie-ID	id	True	integer	Bezeichner der Kategorie.

Gibt zurück

Body: category

Abrufen einer Rechnung

Vorgangs-ID:: Get_invoices_id

Rufen Sie eine einzelne Rechnung nach ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Rechnungs-ID	id	True	integer	Bezeichner der Rechnung.

Gibt zurück

Body: invoice

Abrufen eines Benutzers

Vorgangs-ID:: Get_users_id

Rufen Sie einen einzelnen Benutzer anhand der ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Benutzer-ID	id	True	integer	Bezeichner des Benutzers.

Gibt zurück

Body: user

Abrufen eines Kontos

Vorgangs-ID:: Get_accounts_id

Rufen Sie ein Konto nach ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Konto-ID	id	True	integer	Bezeichner des Kontos.

Gibt zurück

Body: account

Alle Benutzer auflisten

Vorgangs-ID:: Get_users

Ruft alle Benutzer ab.

Parameter

Name	Schlüssel	Typ	Beschreibung
Seitenzahl	page	integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	per_page	integer	Anzahl der Datensätze pro Seite.
Sortieren	sort	array	Sortieren Sie die Ergebnisse. Ändern der Reihenfolge mithilfe von `<sort_by>:[asc\|desc]`

Gibt zurück

response: array of user

Alle Bezeichnungen auflisten

Vorgangs-ID:: Get_labels

Rufen Sie alle Bezeichnungen ab.

Parameter

Name	Schlüssel	Typ	Beschreibung
Seitenzahl	page	integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	per_page	integer	Anzahl der Datensätze pro Seite.
Filtern nach Modelltyp der Bezeichnung	model_type	string	Filterbeschriftungen basierend auf dem Modelltyp.

Gibt zurück

response: array of label

Alle Kategorien auflisten

Vorgangs-ID:: Get_categories

Ruft alle Kategorien ab.

Parameter

Name	Schlüssel	Typ	Beschreibung
Seitenzahl	page	integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	per_page	integer	Anzahl der Datensätze pro Seite.
Sortieren	sort	array	Sortieren Sie die Ergebnisse. Ändern der Reihenfolge mithilfe von `<sort_by>:[asc\|desc]`

Gibt zurück

response: array of category

Alle Konten auflisten

Vorgangs-ID:: Get_accounts

Ruft alle Konten ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Seitenzahl	page		integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	per_page		integer	Anzahl der Datensätze pro Seite.

Gibt zurück

response: array of account

Alle Kurse auflisten

Vorgangs-ID:: Get_courses

Erhalten Sie alle Kurse.

Parameter

Name	Schlüssel	Typ	Beschreibung
Seitenzahl	page	integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	per_page	integer	Anzahl der Datensätze pro Seite.
Sortieren	sort	array	Sortieren Sie die Ergebnisse. Ändern der Reihenfolge mithilfe von `<sort_by>:[asc\|desc]`

Gibt zurück

response: array of course

Alle Rechnungen auflisten

Vorgangs-ID:: Get_invoices

Rufen Sie alle Rechnungen ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Seitenzahl	page		integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	per_page		integer	Anzahl der Datensätze pro Seite.

Gibt zurück

response: array of invoice

Alle Rechnungssteuersätze auflisten

Vorgangs-ID:: Get_invoice_vats

Abrufen aller Rechnungssteuersätze

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Seitenzahl	page		integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	per_page		integer	Anzahl der Datensätze pro Seite.

Gibt zurück

response: array of invoice_vat

Hinzufügen einer Authentifizierung

Vorgangs-ID:: Post_authentication

Hinzufügen einer Authentifizierungsmethode zu einem vorhandenen Benutzer

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
user_id	user_id	True	integer	Die ID des Benutzers, zu dem diese Authentifizierung gehört.
authentication_provider_type	authentication_provider_type	True	string	Der Typ des Authentifizierungsanbieters.
uid	uid	True	string	Der eindeutige Bezeichner dieser Authentifizierung, der der eindeutigen ID des IDP entspricht.

Gibt zurück

Body: authentication

Hinzufügen einer Rechnung

Vorgangs-ID:: Post_invoices

Fügen Sie Ihrer Administration eine Rechnung hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Account	account_id	True	number	Bezeichner des Kontos.
account_name	account_name		string	Der Name des Kontos, das bezahlt wird. Wird in die Rechnung kopiert und wird daher nicht automatisch aktualisiert, wenn sich der Kontoname ändert.
Währung	currency	True	string	Die Währung der Rechnung.
id	id		integer	Eindeutiger Bezeichner des Rechnungselements.
Einheiten	units	True	number	Die Anzahl der Einheiten des Rechnungselements.
Description	name	True	string	Der Name des Rechnungselements.
Preis	unit_price	True	string	Der Preis einer Einheit.
Mehrwertsteuer	invoice_vat_id		number	Bezeichner der Rechnung mwSt.
Katalogvariante	catalog_variant_id		number	Bezeichner der Katalogvariante.
updated_at	updated_at		string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at		string	Zeitstempel der Erstellung.
feature	feature		string	Eine Beschreibung der Rechnung, die auf der Rechnung angezeigt wird.
Fußnote	footnote		string	Die Notiz, die unten auf der Rechnung angezeigt wird.

Gibt zurück

Body: invoice

Hinzufügen einer Rechnungssteuer

Vorgangs-ID:: Post_invoice_vats

Fügen Sie eine Rechnungssteuer hinzu, die auf der Rechnung verwendet werden kann.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id		integer	Eindeutiger Idenitfier der Rechnungssteuer.
name	name	True	string	Name der Rechnung MwSt.
Prozentwert	percentage	True	string	Die Zahl, die den Mehrwertsteuerprozentsatz darstellt.

Gibt zurück

Body: invoice_vat

Hinzufügen eines Benutzers

Vorgangs-ID:: Post_users

Fügen Sie Ihrer Verwaltung einen Benutzer hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Vorname	first_name	True	string	Vorname des Benutzers.
Zweiter Vorname	middle_name		string	Zweiter Name des Benutzers.
Nachname	last_name	True	string	Nachname des Benutzers.
Email	email	True	string	Die E-Mail des Benutzers.
Telefonnummer	phone		string	Die Telefonnummer des Benutzers.
Newsletter abonnieren	wants_newsletter		boolean	Möchte der Benutzer Newsletter erhalten?
Erstellen einer Authentifizierung	with_authentication		boolean	Erstellen Sie eine Authentifizierung für den Benutzer, sodass sich der Benutzer anmelden kann.
Gebietsschema	locale		string	Das Gebietsschema des Benutzers.
label_ids	label_ids		array of number
id	id		integer	Eindeutiger Bezeichner der Adresse.
Empfänger	addressee		string	Der Adressempfänger der Adresse.
address	address	True	string	Verkettung der Straße und Hausnummer.
postal_code	postal_code	True	string	Eine Zeichenfolge, die die Postleitzahl darstellt.
city	city	True	string	Eine Zeichenfolge, die die Stadt darstellt.
country	country	True	string	Eine Zeichenfolge, die das Land darstellt.
updated_at	updated_at		string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at		string	Zeitstempel der Erstellung.
notes_user	notes_user		string	Kurze Notiz zum Benutzer.

Gibt zurück

Body: user

Hinzufügen eines Kontos

Vorgangs-ID:: Post_accounts

Fügen Sie Ihrer Administration ein Konto hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
name	name	True	string	Der Kontoname.
E-Mail	email		string	Eine Zeichenfolge, die die Abrechnungs-E-Mail des Kontos darstellt.
id	id		integer	Eindeutiger Bezeichner der Adresse.
Empfänger	addressee		string	Der Adressempfänger der Adresse.
address	address	True	string	Verkettung der Straße und Hausnummer.
postal_code	postal_code	True	string	Eine Zeichenfolge, die die Postleitzahl darstellt.
city	city	True	string	Eine Zeichenfolge, die die Stadt darstellt.
country	country	True	string	Eine Zeichenfolge, die das Land darstellt.
updated_at	updated_at		string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at		string	Zeitstempel der Erstellung.

Gibt zurück

Body: account

Hinzufügen eines Kurses

Vorgangs-ID:: Post_courses

Fügen Sie Ihrer Verwaltung einen Kurs hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id		integer	Eindeutiger Bezeichner des Kurses
name	name	True	string	Der Name des Kurses.
Position	position		number	Sortierposition des Kurses. Niedriger ist höher.
signup_url	signup_url		string	URL zur Anmeldeseite für diesen Kurs.
slug_history	slug_history		array of string	Liste der alten Slugs, alte Anrufe werden umgeleitet.
Avatar	avatar		string	URL zu einem geänderten Avatarbild (300x200^).
certificate_template_id	certificate_template_id		number	Bezeichner der optional verknüpften Zertifikatvorlage.
Kategorie	category_id	True	number	Bezeichner der Kategorie des Kurses.
Code	code	True	string	Der Code des Kurses.
kosten	cost		string	Der Preis, der für diesen Kurs bezahlt werden soll.
cost_scheme	cost_scheme		string	Wie sollte der Kurs standardmäßig bezahlt werden.
is_published	is_published		boolean	Boolescher Wert, der den Veröffentlichungsstatus des Kurses darstellt.
updated_at	updated_at		string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at		string	Zeitstempel der Erstellung.

Gibt zurück

Body: course

Kategorie hinzufügen

Vorgangs-ID:: Post_categories

Fügen Sie Ihrer Verwaltung eine Kategorie hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id		integer	Eindeutiger Bezeichner der Kategorie.
Name	name	True	string	Titel der Kategorie.
Description	description		string	Die Beschreibung der Kategorie.
Position	position		number	Sortierposition der Kategorie. Niedriger ist höher.
parent_id	parent_id		number	Eindeutiger Bezeichner der übergeordneten Kategorie
Avatar	avatar		string	URL zum Kategorie-Avatar.
Veröffentlicht	is_published		boolean	Sollte die Kategorie auf der Website veröffentlicht werden.
courses_count	courses_count		number	Anzahl der Kurse, die direkt mit dieser Kategorie verknüpft sind.
children_count	children_count		number	Anzahl der untergeordneten Kategorien, die direkt mit dieser Kategorie verknüpft sind.
updated_at	updated_at		string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at		string	Zeitstempel der Erstellung.
avatar_url	avatar_url		string	URL zu einem geänderten Avatarbild (300x200^).

Gibt zurück

Body: category

Kurs abrufen

Vorgangs-ID:: Get_courses_id

Abrufen eines einzelnen Kurses nach ID

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kurs-ID	id	True	integer	Bezeichner des Kurses.

Gibt zurück

Body: course

Löschen einer Authentifizierung eines Benutzers

Vorgangs-ID:: Delete_authentication_by_user_id

Löschen Sie eine der Authentifizierungen eines Benutzers. Beachten Sie, dass Sie die letzte Authentifizierung nicht löschen können!

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Benutzer-ID	user_id	True	integer	Bezeichner des Benutzers.
Authentifizierungs-ID	authentication_id	True	integer	Bezeichner der Authentifizierung.

Auslöser

Abonnieren eines Webhooks

Abonnieren Sie einen Webhook, um über Datensatzaktualisierungen benachrichtigt zu werden.

Abonnieren eines Webhooks

Vorgangs-ID:: Post_webhooks

Abonnieren Sie einen Webhook, um über Datensatzaktualisierungen benachrichtigt zu werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id		string	Eindeutiger Bezeichner des Webhooks. (a UUID).
active	active		boolean	Status des Webhooks.
events	events	True	array of string	Array von Ereignissen, die diesen Webhook auslösen sollen.

Gibt zurück

Body: webhook_payload

Definitionen

Konto

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner des Kontos.
name	name	string	Der Kontoname.
E-Mail	email	string	Eine Zeichenfolge, die die Abrechnungs-E-Mail des Kontos darstellt.
account_type	account_type	string	Der Kontotyp.
address	address	address
phone	phone	string	Eine Zeichenfolge, die die Telefonnummer des Kontos darstellt.
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.
signup_answers	signup_answers	array of customField	Liste der Anmeldeantworten für dieses Konto.

address

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner der Adresse.
Empfänger	addressee	string	Der Adressempfänger der Adresse.
address	address	string	Verkettung der Straße und Hausnummer.
postal_code	postal_code	string	Eine Zeichenfolge, die die Postleitzahl darstellt.
city	city	string	Eine Zeichenfolge, die die Stadt darstellt.
country	country	string	Eine Zeichenfolge, die das Land darstellt.
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.

Authentifizierung

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner der Authentifizierung.
user_id	user_id	integer	Die ID des Benutzers, zu dem diese Authentifizierung gehört.
authentication_provider_id	authentication_provider_id	integer	Die ID des Authentifizierungsanbieters.
uid	uid	string	Der eindeutige Bezeichner dieser Authentifizierung, der der eindeutigen ID des IDP entspricht.
Wenn OTP für diese Anmeldung aktiviert ist.	otp_enabled		Falls der Authentifizierungsanbieter Eduframe ist, gibt an, ob für diese Anmeldung ein Einmalkennwort aktiviert ist, für alle anderen Anbieter "false".
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.

customField

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner der Anmeldeantwort.
value	value	string	Der formatierte Wert der Antwort.
signup_question_id	signup_question_id	integer	Eindeutiger Bezeichner der Frage.

Kategorie

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner der Kategorie.
Name	name	string	Titel der Kategorie.
Description	description	string	Die Beschreibung der Kategorie.
Position	position	number	Sortierposition der Kategorie. Niedriger ist höher.
parent_id	parent_id	number	Eindeutiger Bezeichner der übergeordneten Kategorie
Avatar	avatar	string	URL zum Kategorie-Avatar.
Veröffentlicht	is_published	boolean	Sollte die Kategorie auf der Website veröffentlicht werden.
courses_count	courses_count	number	Anzahl der Kurse, die direkt mit dieser Kategorie verknüpft sind.
children_count	children_count	number	Anzahl der untergeordneten Kategorien, die direkt mit dieser Kategorie verknüpft sind.
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.
avatar_url	avatar_url	string	URL zu einem geänderten Avatarbild (300x200^).

Kurs

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner des Kurses
name	name	string	Der Name des Kurses.
Position	position	number	Sortierposition des Kurses. Niedriger ist höher.
signup_url	signup_url	string	URL zur Anmeldeseite für diesen Kurs.
Avatar	avatar	string	URL zu einem geänderten Avatarbild (300x200^).
certificate_template_id	certificate_template_id	number	Bezeichner der optional verknüpften Zertifikatvorlage.
Kategorie	category_id	number	Bezeichner der Kategorie des Kurses.
Code	code	string	Der Code des Kurses.
kosten	cost	string	Der Preis, der für diesen Kurs bezahlt werden soll.
cost_scheme	cost_scheme	string	Wie sollte der Kurs standardmäßig bezahlt werden.
is_published	is_published	boolean	Boolescher Wert, der den Veröffentlichungsstatus des Kurses darstellt.
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.

user

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner des Benutzers
Mitarbeiternummer	employee_number	string	Die Mitarbeiternummer dieses Benutzers.
Vorname	first_name	string	Vorname des Benutzers.
Zweiter Vorname	middle_name	string	Zweiter Name des Benutzers.
Nachname	last_name	string	Nachname des Benutzers.
Email	email	string	Die E-Mail des Benutzers.
Telefonnummer	phone	string	Die Telefonnummer des Benutzers.
labels	labels	array of label
Newsletter abonnieren	wants_newsletter	boolean	Möchte der Benutzer Newsletter erhalten?
Erstellen einer Authentifizierung	with_authentication	boolean	Erstellen Sie eine Authentifizierung für den Benutzer, sodass sich der Benutzer anmelden kann.
Gebietsschema	locale	string	Das Gebietsschema des Benutzers.
address	address	address
Avatar	avatar_url	string	Der relative URL-Pfad zum Avatar.
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.

Rechnung

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner der Rechnung.
reference_id	reference_id	string	Referenz-ID der Rechnung. Wird verwendet, um die Rechnung zu finden.
Account	account_id	number	Bezeichner des Kontos.
number	number	string	Die Rechnungsnummer, die pro Dozent eindeutig ist. Wenn sie leer gelassen wird, wird sie automatisch erhöht.
number_int	number_int	number	Die Rechnungsnummer, die in einen ganzzahligen Wert konvertiert wurde.
status	status	string	Der Status der Rechnung. Der Anfangsstatus wird immer konzeptisiert.
expiration_date	expiration_date	string	Das Ablaufdatum der Rechnung. Wird festgelegt, wenn die Rechnung geöffnet wird.
opened_at	opened_at	string	Das Datum, an dem der Rechnungsstatus so geändert wurde, dass er geöffnet wurde.
Beschreibung	description	string	Lesbare Beschreibung der Rechnung.
account_name	account_name	string	Der Name des Kontos, das bezahlt wird. Wird in die Rechnung kopiert und wird daher nicht automatisch aktualisiert, wenn sich der Kontoname ändert.
Währung	currency	string	Die Währung der Rechnung.
total_incl	total_incl	string	Die Gesamtkosten der Rechnung einschließlich MwSt.
total_excl	total_excl	string	Die Gesamtkosten der Rechnung ohne MwSt.
total_open	total_open	string	Die offenen Kosten der Rechnung einschließlich MwSt.
pdf_url	pdf_url	string	Url zum Downloadpfad der Rechnung im PDF-Format.
xml_url	xml_url	string	Url zum Downloadpfad der Rechnung im UML-Format.
feature	feature	string	Eine Beschreibung der Rechnung, die auf der Rechnung angezeigt wird.
Fußnote	footnote	string	Die Notiz, die unten auf der Rechnung angezeigt wird.
invoice_items	invoice_items	array of invoice_item
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.

invoice_item

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner des Rechnungselements.
Einheiten	units	number	Die Anzahl der Einheiten des Rechnungselements.
Description	name	string	Der Name des Rechnungselements.
Preis	unit_price	string	Der Preis einer Einheit.
Mehrwertsteuer	invoice_vat_id	number	Bezeichner der Rechnung mwSt.
Katalogvariante	catalog_variant_id	number	Bezeichner der Katalogvariante.
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.

invoice_vat

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Idenitfier der Rechnungssteuer.
name	name	string	Name der Rechnung MwSt.
Prozentwert	percentage	string	Die Zahl, die den Mehrwertsteuerprozentsatz darstellt.

catalog_variant

Name	Pfad	Typ	Beschreibung
id	id	number	Eindeutiger Bezeichner der Katalogvariante
product_id	product_id	number	Eindeutiger Bezeichner des Katalogprodukts
name	name	string	Der Name des Kurses.
cost_scheme	cost_scheme	string	Wie sollte die Katalogvariante standardmäßig bezahlt werden.
kosten	cost	string	Der Preis, der für diese Katalogvariante bezahlt werden soll.
Währung	currency	string	Die Währung der Katalogvariante.
variantable_type	variantable_type	string	Die Währung der Rechnung.
variantable_id	variantable_id	number	Eindeutiger Bezeichner des variantenfähigen Elements.
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.
Veröffentlicht	is_published	boolean	Sollte die Kategorie auf der Website veröffentlicht werden.

label

Name	Pfad	Typ	Beschreibung
id	id	number	Eindeutiger Bezeichner der Bezeichnung
Name	name	string	Der Name der Bezeichnung.
Farbe	color	string	Hexcode der Farbe des Etiketts.
Model	model_type	string	Der Modelltyp, für den diese Bezeichnung verfügbar gemacht wird.
updated_at	updated_at	string	Zeitstempel der letzten Aktualisierung.
erstellt_am	created_at	string	Zeitstempel der Erstellung.

webhook_payload

Name	Pfad	Typ	Beschreibung
Erzieher	educator	string	Slug der Pädagogen.
Ereignis	event	string	Typ des Ereignisses, das den Webhook ausgelöst hat.
entity_type	entity_type	string	Typ des Modells, das den Webhook ausgelöst hat.
entity_id	entity_id	number	Eindeutiger Bezeichner des Modells, das den Webhook ausgelöst hat.
Mieter_ID	tenant_id	string	UUID der Pädagogen.

Freigeben über

Eduframe

Voraussetzungen

So erhalten Sie Anmeldeinformationen

Erste Schritte mit Ihrem Connector

Drosselungsgrenzwerte

Aktionen

Abrufen aller Katalogvarianten

Parameter

Gibt zurück

Abrufen der Authentifizierungen eines Benutzers

Parameter

Gibt zurück

Abrufen einer Kategorie

Parameter

Gibt zurück

Abrufen einer Rechnung

Parameter

Gibt zurück

Abrufen eines Benutzers

Parameter

Gibt zurück

Abrufen eines Kontos

Parameter

Gibt zurück

Alle Benutzer auflisten

Parameter

Gibt zurück

Alle Bezeichnungen auflisten

Parameter

Gibt zurück

Alle Kategorien auflisten

Parameter

Gibt zurück

Alle Konten auflisten

Parameter

Gibt zurück

Alle Kurse auflisten

Parameter

Gibt zurück

Alle Rechnungen auflisten

Parameter

Gibt zurück

Alle Rechnungssteuersätze auflisten

Parameter

Gibt zurück

Hinzufügen einer Authentifizierung

Parameter

Gibt zurück

Hinzufügen einer Rechnung

Parameter

Gibt zurück

Hinzufügen einer Rechnungssteuer

Parameter

Gibt zurück

Hinzufügen eines Benutzers

Parameter

Gibt zurück

Hinzufügen eines Kontos

Parameter

Gibt zurück

Hinzufügen eines Kurses

Parameter

Gibt zurück

Kategorie hinzufügen

Parameter

Gibt zurück

Kurs abrufen

Parameter

Gibt zurück

Löschen einer Authentifizierung eines Benutzers

Parameter

Auslöser

Abonnieren eines Webhooks

Parameter

Gibt zurück

Definitionen

Konto

address

Authentifizierung