Konfigurieren einer API für das Build von FastReport Online Designer

Mit dem FastReport Online Designer Builder können Sie jetzt einen Designer über die API erstellen. Zuvor mussten die Benutzer den Designer manuell im FastReport Online Designer Builder erstellen. Das Ergebnis des Builds kann in der App heruntergeladen oder per E-Mail empfangen werden. Jetzt können Sie diesen Prozess automatisieren, um FastReport Online Designer zu aktualisieren, wenn sich die Produktversion ändert. Dazu müssen Sie eine Funktion erstellen, die mit der API funktioniert und das Designer Build auf Ihren Servern bereitstellt. Ein Beispiel für die Verwendung der API: Sie können die Produktversion einmal am Tag abfragen und wenn sie sich geändert hat, automatisch вфы Build anfordern. Und dann den aktualisierten Designer hosten.

API-Schlüssel

Die Benutzerautorisierung erfolgt über einen API-Schlüssel, den Sie im FastReport Online Designer Builder erstellen können. Um einen Schlüssel zu erstellen, müssen Sie:

- sich bei Ihrem Konto anmelden;
- zum neuen Menüpunkt „API-Schlüssel“ gehen;
- auf die Schaltfläche in der rechten unteren Ecke oder auf die rote Aufschrift klicken.

Danach wird ein neuer API-Schlüssel generiert. Sie können auf den Schlüssel klicken, um ihn zu kopieren und ihn zur Autorisierung der API zu verwenden.

Build-Anfrage

Um ein Build anzufordern, senden Sie eine POST-Anfrage an:

https://dsg2014.fast-report.com:3000/builderAPI/build

Der Request-Body muss mindestens Ihren API-Schlüssel enthalten. Wenn der Parameter nicht angegeben wird, wird sein Standardwert verwendet!

Beispiel für eine minimale Anfrage:

{
"APIkey": "Ihr API-Schlüssel"
}

Im Folgenden werden die Parameter beschrieben, die von der API für das Build akzeptiert werden.

Parameter
Wert	Beschreibung
themes	Thema, mit dem das Build durchgeführt wird.
	Datentyp: Zeile
	Die Werte sind in der Themen Tabelle angegeben.
components	In das Build aufzunehmende Komponenten.
	Datentyp: Array
	Die Werte sind in der Komponenten Tabelle angegeben.
bands	In das Build aufzunehmende Bands.
	Datentyp: Array
	Die Werte sind in der Bands Tabelle angegeben.
controls	In das Build aufzunehmende Dialogfeld-Controls.
	Datentyp: Array
	Die Werte sind in der Controls Tabelle angegeben.
plugins	In das Build aufzunehmende Plugins.
	Datentyp: Array
	Die Werte sind in der Plugins Tabelle angegeben.
customization	In das Build aufzunehmende Panels.
	Datentyp: Array
	Die Werte sind in der Panel Tabelle angegeben.
config	Build-Konfiguration.
	Datentyp: Objekt
	Die Struktur des Objekts ist in der Einstellungen Tabelle angegeben.

Themen
Wert	Beschreibung
none	Verwenden Sie das Thema nicht.
classic	Verwenden Sie ein klassisches Thema.
mini	Verwenden Sie ein minimales Thema.

Komponenten
Wert	Beschreibung
TextObject	Textkomponente
PictureObject	Komponente Bild
ShapeObject	Komponente Figur
PolygonObject	Komponente Polygon
PolyLineObject	Komponente Polylinie
LineObject	Komponente Linie
SubreportObject	Komponente Unterbericht
TableObject	Komponente Tabelle
MatrixObject	Komponente Matrix
AdvMatrixObject	Komponente Erweiterte Matrix
BarcodeObject	Komponente Barcode
RichObject	Komponente Rich Text
CheckBoxObject	Komponente Kontrollkästchen
CellularTextObject	Komponente Text in Zellen
LinearGauge	Komponente Lineargeber
SimpleGauge	Komponente Einfacher Geber
RadialGauge	Komponente Rotatorischer Geber
SimpleProgressGauge	Komponente Einfacher Fortschrittsanzeiger
HtmlObject	Komponente HTML
SVGObject	Komponente SVG
ContainerObject	Komponente Container
DigitalSignatureObject	Komponente Digitale Signatur
MapObject	Komponente Karte

Bands
Wert	Beschreibung
ReportTitleBand	Bericht-Kopfzeile
ReportSummaryBand	Bericht-Zusammenfassung
PageHeaderBand	Seitenkopf
PageFooterBand	Fußzeile
ColumnHeaderBand	Spaltenüberschrift
ColumnFooterBand	Spaltenfuß
DataHeaderBand	Daten-Kopfzeile
DataBand	Daten
DataFooterBand	Datenfußzeile
GroupHeaderBand	Gruppenkopfzeile
GroupFooterBand	Gruppenfußzeile
ChildBand	Child-Band
OverlayBand	Overlay-Band

Controls
Wert	Beschreibung
ButtonControl	Schaltfläche
CheckBoxControl	Kontrollkästchen
CheckedListBoxControl	Auswahlliste
ComboBoxControl	Textfeld mit einer Dropdownliste
DateTimePickerControl	Datumseingabefeld
LabelControl	Aufschrift
ListBoxControl	Liste
MonthCalendarControl	Kalender
RadioButtonControl	Schalter
TextBoxControl	Textfeld

Plugins
Wert	Beschreibung
CODE	Codierte Seite
GUIDES	Leitlinien
POSITION_BLOCK	Komponentenposition beim Bewegen
RULER	Lineal
BAND_HORZ_RESIZER	Ändern der horizontalen Bandbreite
HOTKEY	Hot-Tasten
CONTEXT_MENU	Kontextmenü
DBLCLICK	Doppelklick

Panel
Wert	Beschreibung
Properties	Eigenschaften
Events	Ereignisse
ReportTree	Berichtsbaum
Data	Datenquellen
Preview	Seitenvorschau

Einstellungen

Wert

Beschreibung

features

Datentyp: Array

Die Werte sind in der Funktionen Tabelle angegeben.

entryName

Datentyp: Objekt

{

"name": "index",

"ext": "html"

}

publicPath

Datentyp: Zeile

Öffentlicher Pfad zur Anwendung auf dem Server.

saveSuccessRedirect

Datentyp: Objekt

{

"url": null,

"blank": false,

"useParent": false,

"removeConfirmation": true

}

customFonts

Link zu Schriftarten

API

Datentyp: Array

Die Werte sind in der API Tabelle angegeben.

Funktionen

{

"name": "SHOW_BAND_TITLE",

"enabled": true

}

Das Objekt enthält einen Funktionsschlüssel und ein Kennzeichen

Wert

Beschreibung

SHOW_BAND_TITLE

Band-Kopfzeile

ADD_BANDS

Hinzufügen von Bands

SORT_BANDS

Band-Sortierung

RESIZE_BANDS

Band-Größenänderung

CONFIRM_BEFORE_EXIT

Bestätigung vor dem Austritt

MOVABLE_POPUPS

Bewegliche Dialogfelder

REVISION_FILES

Hash in Dateinamen

MINIFY

Code-Minifizierung

ENABLE_PREVIEW_BUTTON

Schaltfläche "Vorschau“

READONLY_MODE

Lesemodus

AUTOSAVE

Automatische Speicherung

API

{

"name": "API_SAVE_REPORT",

"value": "../FastReport.Export.axd?putReport=#{id}"

}

Das Objekt enthält einen API-Schlüssel und einen Link

Wert

Beschreibung

API_SAVE_REPORT

Bericht speichern

API_MAKE_PREVIEW

Berichtvorschau

API_GET_REPORT

Bericht erhalten

API_GET_FUNCTIONS

Funktionen erhalten

API_GET_CUSTOM_CONFIG

Anwendungskonfiguration

API_GET_CONNECTION_TYPES

Verbindungstypen

API_GET_CONNECTION_TABLES

Verbindungstabellen

API_GET_CONNECTION_STRING_PROPERTIES

Eigenschaften der Verbindungszeichenfolge

API_MAKE_CONNECTION_STRING

Verbindungszeichenfolge erstellen

API_GET_MSCHART_TEMPLATE

MSChart -Vorlage

Nachdem Sie ein Build angefordert haben, erhalten Sie eine UUID, mit der Sie ihren Status überprüfen können. Rückmeldungsbeispiel:

{
 "message": "Successfully queued",
 "code": 0,
 "payload": {
 "UUID": "25d36576-c5e2-49f4-8ab0-73838c457336"
 }
}

Build-Status überprüfen

Um den Build-Status zu überprüfen, stellen Sie eine GET-Anfrage an:

https://dsg2014.fast-report.com:3000/builderAPI/checkBuild/{apiKey}/{buildUUID}

In dem Link müssen Sie Ihren für das Build verwendeten API-Schlüssel und die UUID angeben, die Sie bei der Anfrage erhalten haben.

In der Rückmeldung können mehrere Status angezeigt werden, je nachdem, in welcher Phase sich das Build befindet.

1 (QUEUED) – Das Build ist geplant und nun in der Warteschlange.
2 (PROCESSING) – Das Build ist gestartet, aber noch in Bearbeitung.
3 (BUILT) – Das Build ist abgeschlossen und kann heruntergeladen werden.

Rückmeldungsbeispiel:

{
 "code": 0,
 "payload": {
 "statusCode": 2,
 "statusText": "PROCESSING"
 }
}

Wenn das Build abgeschlossen ist, erhalten Sie in der Rückmeldung einen Link zum Herunterladen.

Herunterladen des neuesten Builds

Um die zusammengesetzte Anwendung herunterzuladen, stellen Sie eine GET-Anfrage an:

https://dsg2014.fast-report.com:3000/builderAPI/download/{apiKey}

In dem Link müssen Sie Ihren API-Schlüssel angeben. Als Rückmeldung auf die Anfrage erhalten Sie eine Archivdatei mit der zusammengesetzten Anwendung.

Aktuelle Version von FastReport Online Designer erhalten

Um die aktuelle Version der Anwendung zu erhalten, stellen Sie eine GET-Anfrage an:

https://dsg2014.fast-report.com:3000/builderAPI/designer-version/{apiKey}

In dem Link müssen Sie Ihren API-Schlüssel angeben. Als Rückmeldung erhalten Sie die aktuelle Version von FastReport Online Designer. Rückmeldungsbeispiel:

{
 "payload": {
 "version": "2023.1.3"
 },
 "code": 0
}

Unser Team wird weiterhin an der Verbesserung der Kundenerfahrung mit FastReport Produkten arbeiten. Wenn Sie Fragen haben, wenden Sie sich bitte an unser Support-Team unter support@fast-report.com.