API

Für Entwickler
Wir freuen uns, dass du unsere API benutzen möchtest. Auf dieser Seite erhälst du technische Informationen, wie unsere API funktioniert. Für einen API-Key und Auskünfte zu unseren Preisen, schreibe einfach eine kurze Mail an:

mail@dekomaker.de
GET https://dekomaker.de/api/alive
Dieser Endpunkt fragt ab, ob der Dienst verügbar ist.
POST https://dekomaker.de/api/user
Dieser Endpunkt gibt die Benutzerinformationen zu einem API-Key zurück.

Allgemein
Key Value Erklärung
apiKey String Verwende den bereitgestellten API-Key im Format xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxx.

Beispiel Request Body [JSON]
{"apiKey":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}
POST https://dekomaker.de/api/render
Dieser Endpunkt dient zum Rendern eines Designs.

Allgemein
Key Value Erklärung
apiKey String Verwende den bereitgestellten API-Key im Format xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxx.
designName String Name des zu rendernden Designs. Mögliche Values: "familyTree"
outputFormat String Das Format, in dem das Design gerendert werden soll. Mögliche Values: "pdf", "jpg", "png"
imageWidth, imageHeight String Wenn die Ausgabe als jpg oder png gewählt wird, können die Abmessungen in Pixel konfiguriert werden. Wenn nicht definiert oder höher als Standard, werden die Standardabmessungen des Designs verwendet.

Stammbaum
Key Value Erklärung
numberOfGenerations String Die Anzahl der Generationen die der Stammbaum haben soll. Mögliche Values: "1", "2", "3", "4", "5"
backgroundColor String Die Hintergrundfarbe des Stammbaums in hexadezimaler Darstellung. Beispiel Value: "#000000"
headlineFont String Die Schriftart in der die Überschrift geschrieben werden soll. Mögliche Values: "Magnum", "Adam", "Gabrielle", "Mode", "Regina", "Roustel", "Sristian"
headlineColor String Die Farbe der Überschrift in hexadezimaler Darstellung. Beispiel Value: "#000000"
headline_1 String Text der ersten Zeile der Überschrift.
headline_2 String Text der zweiten Zeile der Überschrift.
triangleTextFont String Die Schriftart in der die Daten in den Dreiecken geschrieben werden soll. Mögliche Values: "Euro", "Doulos", "Liberation", "Linux", "Roboto", "Roman", "Timeless"
generation_1_triangleBackgroundColor, generation_2_triangleBackgroundColor, generation_3_triangleBackgroundColor, generation_4_triangleBackgroundColor, generation_5_triangleBackgroundColor String Die Hintergrundfarbe der Dreiecke in hexadezimaler Darstellung. Beispiel Value: "#000000"
generation_X_person_Y_firstName, generation_X_person_Y_surName, generation_X_person_Y_birthDate, generation_X_person_Y_deathDate String Die Daten der Personen im Stammbaum. Ersetze das "X" im Key durch die Nummer der Generation (1-5, 1 für die Jüngste) und ersetze das "Y" im Key durch die Personennummer in der Generation. (Generation 1 hat 1 Person, Generation 2 hat 2 Personen, Generation 3 hat 4 Personen, Generation 4 hat 8 Personen und Generation 5 hat 16 Personen). Beispiel: "generation_4_person_2_firstName": "John"

Beispiel Request Body [JSON]
{"apiKey":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "designName":"familyTree", "outputFormat":"pdf", "imageWidth":"1700", "imageHeight":"1700", "numberOfGenerations":"4", "backgroundColor":"#FFFFFF", "headlineFont":"Magnum", "headlineColor":"000000", "headline_1":"My", "headline_2":"Family", "triangleTextFont":"Euro", "generation_1_triangleBackgroundColor":"#B75D69", "generation_2_triangleBackgroundColor":"#EACDC2", "generation_3_triangleBackgroundColor":"#774C60", "generation_4_triangleBackgroundColor":"#774C60", "generation_5_triangleBackgroundColor":"#774C60", "generation_1_triangleTextColor":"#000000", "generation_2_triangleTextColor":"#FFFFFF", "generation_3_triangleTextColor":"#FFFFFF", "generation_4_triangleTextColor":"#FFFFFF", "generation_5_triangleTextColor":"#FFFFFF", "generation_1_person_1_firstName":"Firstname", "generation_1_person_1_surName":"Surname", "generation_1_person_1_birthDate":"01.01.1970", "generation_1_person_1_deathDate":"01.01.1970", "generation_2_person_1_firstName":"Firstname", "generation_2_person_1_surName":"Surname", "generation_2_person_1_birthDate":"01.01.1970", "generation_2_person_1_deathDate":"01.01.1970", "generation_2_person_2_firstName":"Firstname", "generation_2_person_2_surName":"Surname", "generation_2_person_2_birthDate":"01.01.1970", "generation_2_person_2_deathDate":"01.01.1970", "generation_3_person_1_firstName":"Firstname", "generation_3_person_1_surName":"Surname", "generation_3_person_1_birthDate":"01.01.1970", "generation_3_person_1_deathDate":"01.01.1970", "generation_3_person_2_firstName":"Firstname", "generation_3_person_2_surName":"Surname", "generation_3_person_2_birthDate":"01.01.1970", "generation_3_person_2_deathDate":"01.01.1970", "generation_3_person_3_firstName":"Firstname", "generation_3_person_3_surName":"Surname", "generation_3_person_3_birthDate":"01.01.1970", "generation_3_person_3_deathDate":"01.01.1970", "generation_3_person_4_firstName":"Firstname", "generation_3_person_4_surName":"Surname", "generation_3_person_4_birthDate":"01.01.1970", "generation_3_person_4_deathDate":"01.01.1970", "generation_4_person_1_firstName":"Firstname", "generation_4_person_1_surName":"Surname", "generation_4_person_1_birthDate":"01.01.1970", "generation_4_person_1_deathDate":"01.01.1970", "generation_4_person_2_firstName":"Firstname", "generation_4_person_2_surName":"Surname", "generation_4_person_2_birthDate":"01.01.1970", "generation_4_person_2_deathDate":"01.01.1970", "generation_4_person_3_firstName":"Firstname", "generation_4_person_3_surName":"Surname", "generation_4_person_3_birthDate":"01.01.1970", "generation_4_person_3_deathDate":"01.01.1970", "generation_4_person_4_firstName":"Firstname", "generation_4_person_4_surName":"Surname", "generation_4_person_4_birthDate":"01.01.1970", "generation_4_person_4_deathDate":"01.01.1970", "generation_4_person_5_firstName":"Firstname", "generation_4_person_5_surName":"Surname", "generation_4_person_5_birthDate":"01.01.1970", "generation_4_person_5_deathDate":"01.01.1970", "generation_4_person_6_firstName":"Firstname", "generation_4_person_6_surName":"Surname", "generation_4_person_6_birthDate":"01.01.1970", "generation_4_person_6_deathDate":"01.01.1970", "generation_4_person_7_firstName":"Firstname", "generation_4_person_7_surName":"Surname", "generation_4_person_7_birthDate":"01.01.1970", "generation_4_person_7_deathDate":"01.01.1970", "generation_4_person_8_firstName":"Firstname", "generation_4_person_8_surName":"Surname", "generation_4_person_8_birthDate":"01.01.1970", "generation_4_person_8_deathDate":"01.01.1970", "generation_5_person_1_firstName":"Firstname", "generation_5_person_1_surName":"Surname", "generation_5_person_1_birthDate":"01.01.1970", "generation_5_person_1_deathDate":"01.01.1970", "generation_5_person_2_firstName":"Firstname", "generation_5_person_2_surName":"Surname", "generation_5_person_2_birthDate":"01.01.1970", "generation_5_person_2_deathDate":"01.01.1970", "generation_5_person_3_firstName":"Firstname", "generation_5_person_3_surName":"Surname", "generation_5_person_3_birthDate":"01.01.1970", "generation_5_person_3_deathDate":"01.01.1970", "generation_5_person_4_firstName":"Firstname", "generation_5_person_4_surName":"Surname", "generation_5_person_4_birthDate":"01.01.1970", "generation_5_person_4_deathDate":"01.01.1970", "generation_5_person_5_firstName":"Firstname", "generation_5_person_5_surName":"Surname", "generation_5_person_5_birthDate":"01.01.1970", "generation_5_person_5_deathDate":"01.01.1970", "generation_5_person_6_firstName":"Firstname", "generation_5_person_6_surName":"Surname", "generation_5_person_6_birthDate":"01.01.1970", "generation_5_person_6_deathDate":"01.01.1970", "generation_5_person_7_firstName":"Firstname", "generation_5_person_7_surName":"Surname", "generation_5_person_7_birthDate":"01.01.1970", "generation_5_person_7_deathDate":"01.01.1970", "generation_5_person_8_firstName":"Firstname", "generation_5_person_8_surName":"Surname", "generation_5_person_8_birthDate":"01.01.1970", "generation_5_person_8_deathDate":"01.01.1970", "generation_5_person_9_firstName":"Firstname", "generation_5_person_9_surName":"Surname", "generation_5_person_9_birthDate":"01.01.1970", "generation_5_person_9_deathDate":"01.01.1970", "generation_5_person_10_firstName":"Firstname", "generation_5_person_10_surName":"Surname", "generation_5_person_10_birthDate":"01.01.1970", "generation_5_person_10_deathDate":"01.01.1970", "generation_5_person_11_firstName":"Firstname", "generation_5_person_11_surName":"Surname", "generation_5_person_11_birthDate":"01.01.1970", "generation_5_person_11_deathDate":"01.01.1970", "generation_5_person_12_firstName":"Firstname", "generation_5_person_12_surName":"Surname", "generation_5_person_12_birthDate":"01.01.1970", "generation_5_person_12_deathDate":"01.01.1970", "generation_5_person_13_firstName":"Firstname", "generation_5_person_13_surName":"Surname", "generation_5_person_13_birthDate":"01.01.1970", "generation_5_person_13_deathDate":"01.01.1970", "generation_5_person_14_firstName":"Firstname", "generation_5_person_14_surName":"Surname", "generation_5_person_14_birthDate":"01.01.1970", "generation_5_person_14_deathDate":"01.01.1970", "generation_5_person_15_firstName":"Firstname", "generation_5_person_15_surName":"Surname", "generation_5_person_15_birthDate":"01.01.1970", "generation_5_person_15_deathDate":"01.01.1970", "generation_5_person_16_firstName":"Firstname", "generation_5_person_16_surName":"Surname", "generation_5_person_16_birthDate":"01.01.1970", "generation_5_person_16_deathDate":"01.01.1970"}