Document toolboxDocument toolbox

API - Public

Für einige Aufgaben per API braucht es einen Zugriff von außen, der öffentlich ist: im wesentlichen Informationen, die ohnehin öffentlich sind (Firmenname, Adresse, und so weiter), aber auch das Firmenlogo, die Geschäftsführung. 

Aber auch Aufgaben, die eher dem Marketing zuzuordnen sind, wie zB Produktbeschreibungen und Bilder von Artikeln, die man verkauft. Das mag Handelsware sein oder können ganz eigene Möbeldesigns sein, oder eben Dienstleistungen (zB CNC-Fertigung oder Montage)

Für Methoden mit diesen Aufrufen wird intern ein allgemeines Token erzeugt, was man nicht speziell anlegt oder zuweist. In den Logs taucht das Token unter dem Namen "PUBLIC_NO_TOKEN" auf. 

Methoden

api_public_index

kann man nur parameterlos aufrufen und erhält eine JSON-Response:

{
currentTime:11:04:59,
currentDate:24.10.2021,
currentYear:2021,
company1:mímr,
company2:playful musings in wood,
street:Kalenberger Graben 16,
ZIP:31134,
city:Hildesheim,
phone:05121-6051838,
email:hello@mimr.io,
country_short:D,
country_long:D,
BGmemberno:1234,
HRno:HRB 123-456,
place_of_jurisdiction:Hildesheim,
adress:mímr  Kalenberger Graben 16  31134 Hildesheim,
vatid:DE123456789,
ceos:[{
	PersonalNr:10,
	Name1:Maulwurf,
	Name2:Krtek
}]
}

api_public_personalphoto

Sofern man ein Personalphoto hinterlegt hat kann man so ein Portrait laden: 

/4DAction/api_public_personalphoto/" + ceo.PersonalNr + ".jpg"

Die Personalnummer bekommt man natürlich öffentlich nur für die Geschäftsführungsebene aus api_public_index.

Das Logo der Firma (Hauptmandant) wird so abgerufen:

/4DAction/api_public_logo/logo.png

Das usrpüngliche Bildformat (jpg, png) wie auch der Name der Bilddatei ist dabei egal.  profacto liefert das Bild unter "logo.png" einfach aus.

api_public_shopitems

Mit folgendem Befehl erhält man eine JSON-Response über folgende Felder von allen Artikeln, die als Verkaufsartikel deklariert sind.

  • ArtikelTypenNr, Kurzbezeichnung, Bezeichnung, ArtikelID, VKPreis, LagerBest, Lange_Tiefe, Breite, Dicke_Hohe

/4DAction/api_public_shopitems

Artikel
[
	{
	ArtikelTypenNr:Möbel_2,
	Kurzbezeichnung:Kommode no°2,
	Bezeichnung:<span>Ein anderes Möbel<br/><br/> <span style=\\"color:#009E60\\">gesunder Wald</span><br/> <span style=\\"color:#EF6B00\\">sichere Forstwirtschaft<br/><br/><span style=\\"color:#262626;font-	style:italic\\">Das Holz stammt aus zertifizierter und nachhaltiger Forstwirtschaft.</span></span></span>,
	Lange_Tiefe:1000,
	Breite:550,
	Dicke_Hohe:700,
	VKPreis:345,
	LagerBest:0,
	ArtikelID:1c13558234b721ce1d0ab7d25b25166d
	}
]

Man kann also im Artikel Styled Text und Emojis verwenden. Diese werden als HTML Code ausgegeben, so daß man die Inhalte 1:1 aus profacto im Web darstellen kann.

api_public_shopitemphotos

Um an die Bilder (Feld Skizze 1) der Artikel zu gelangen, muß man die ArtikelID von api_public_shopitems übergeben: zB

src="/4DAction/api_public_shopitemphotos/1c13558234b721ce1d0ab7d25b25166d.jpg"