Freinet Online
64342 Burkhardtstraße 24
Seeheim-JugenheimGermany

Tel: +49 6257 - 5037290
.

Input-API

Mittels unserer Input-API können Sie Datensätze direkt in Freinet eintragen.
Folgende Module werden hierbei derzeit unterstützt:

  • Modul Einrichtung
  • Modul Angebot
  • Modul Freiwillige

Sofern Sie Fragen zu einem Einsatz-Szenario haben, können Sie uns gerne kontaktieren.

 

Endpoints

Der Endpoint für das erstellen von Einrichtungen lautet

POST https://freinet-online.de/api/input/v3/einrichtung

Der Endpoint für das erstellen von Angeboten lautet

POST https://freinet-online.de/api/input/v3/angebot

Der Endpoint für das erstellen von Personen lautet

POST https://freinet-online.de/api/input/v3/personen
 

Responses

Responses

Antworten der API erfolgen als JSON Objekt
Success
{
    "STATUS": "OK",
    "NEW_EINRICHTUNGID": "{einrichtung_id}"
}
        
Error
{
    "error": {
        "code": 417,
        "message": "Expectation Failed: TargetAgid missing"
    }
}
        
 

Beispiele

Einrichtung

Insert einer Einrichtung

/********************************
* $input_array eines UserInputs
* z.B.
*
* SetupInfos
* $input_array['init']['agencyID']='52'; // AgenturID
* $input_array['init']['accessKey']='xxxxxxxxx'; // AccessKey
* Infos zum User
* $input_array['einrichtung']['name']='Musteragentur';
* AdressDaten
* $input_array['einrichtung']['address']['vorname']='Jan';
* $input_array['einrichtung']['address']['nachname']='Rademacher';
* $input_array['einrichtung']['address']['adress_strasse']='Am Musterweg';
* $input_array['einrichtung']['address']['adress_plz']='26135';
* $input_array['einrichtung']['address']['adress_ort']='Oldenburg';
* Sonstige Infos
* $input_array['einrichtung']['unsupported'][]='Informationen, Informationen, für die es bei Freinet keine ›Entsprechung‹ gibt. (Die Informationen werden gesondert angezeigt)';
* Protokoll
* $input_array['protokoll'][1][title]='Mein Protokoll';
* $input_array['protokoll'][1][content]='Mein Protokollinhalt';
* $input_array[''protokoll''][1][date]='2020-12-29';
*/
$input_array['init']['apiVersion']='1.0';
$input_array['init']['agencyID']='52';
$input_array['init']['accessKey']='xxxxxxxxx';
$input_array['init']['modul']='einrichtung'; // TargetModul freiwillige|einrichtung|angebot|kontakte

$input_array['init']['author']='Muster e.V.'; // TargetModul freiwillige|einrichtung|angebot|kontakte
$input_array['init']['author_mail']='mail@muster_e_V.de'; // TargetModul freiwillige|einrichtung|angebot|kontakte

$input_array['entity']['anrede']='Herr'; // (mixed) Herr|Frau|1|2  (1==Herr, 2==Frau)
$input_array['entity']['titel']='Dr.'; // Prof. Dr.
$input_array['entity']['vorname']='Markus';
$input_array['entity']['nachname']='Muster';


/*********************************
* Versand via cURL
*/
$url='https://freinet-online.de/api/input/v3/einrichtung';

$ch=curl_init($url);

# Setup request to send json via POST.
$payload=json_encode($input_array,JSON_PRETTY_PRINT);

curl_setopt($ch,CURLOPT_POSTFIELDS,$payload);
curl_setopt($ch,CURLOPT_HTTPHEADER,array('Content-Type:application/json'));
# Return response instead of printing.
curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);
# Send request.
$result=curl_exec($ch);
curl_close($ch);
		

Angebot

Insert einer Einrichtung mit Angebot

/********************************
* $input_array eines UserInputs
* z.B.
*
* SetupInfos
* $input_array['init']['agencyID']='52'; // AgenturID
* $input_array['init']['accessKey']='xxxxxxxxx'; // AccessKey
* Infos zur Einrichtung
* $input_array['einrichtung']['name']='Musteragentur';
* AdressDaten
* $input_array['einrichtung']['address']['vorname']='Jan';
* $input_array['einrichtung']['address']['nachname']='Rademacher';
* $input_array['einrichtung']['address']['adress_strasse']='Am Musterweg';
* $input_array['einrichtung']['address']['adress_plz']='26135';
* $input_array['einrichtung']['address']['adress_ort']='Oldenburg';
* Infos zum Angebot
* $input_array['angebot']['angebot_titel']='Vorlesen für Kinder im Vorschulalter';
* AdressDaten
* $input_array['angebot']['address']['vorname']='Jan';
* $input_array['angebot']['address']['nachname']='Rademacher';
* $input_array['angebot']['address']['adress_strasse']='Am Musterweg';
* $input_array['angebot']['address']['adress_plz']='26135';
* $input_array['angebot']['address']['adress_ort']='Oldenburg';
* Sonstige Infos
* $input_array['angebot']['unsupported'][]='Informationen, Informationen, für die es bei Freinet keine ›Entsprechung‹ gibt. (Die Informationen werden gesondert angezeigt)';
* Protokoll
* $input_array['protokoll'][1]['title']='Mein Protokoll';
* $input_array['protokoll'][1]['content']='Mein Protokollinhalt';
* $input_array['protokoll'][1]['date']='2020-12-29';
*/
$input_array['init']['apiVersion']='1.0';
$input_array['init']['agencyID']='52';
$input_array['init']['accessKey']='xxxxxxxxx';
$input_array['init']['modul']='einrichtung'; // TargetModul freiwillige|einrichtung|angebot|kontakte

$input_array['init']['author']='Muster e.V.'; // TargetModul freiwillige|einrichtung|angebot|kontakte
$input_array['init']['author_mail']='mail@muster_e_V.de'; // TargetModul freiwillige|einrichtung|angebot|kontakte

$input_array['entity']['anrede']='Herr'; // (mixed) Herr|Frau|1|2  (1==Herr, 2==Frau)
$input_array['entity']['titel']='Dr.'; // Prof. Dr.
$input_array['entity']['vorname']='Markus';
$input_array['entity']['nachname']='Muster';


/*********************************
* Versand via cURL
*/
$url='https://freinet-online.de/api/input/v3/angebot';

$ch=curl_init($url);

# Setup request to send json via POST.
$payload=json_encode($input_array,JSON_PRETTY_PRINT);

curl_setopt($ch,CURLOPT_POSTFIELDS,$payload);
curl_setopt($ch,CURLOPT_HTTPHEADER,array('Content-Type:application/json'));
# Return response instead of printing.
curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);
# Send request.
$result=curl_exec($ch);
curl_close($ch);
		

Freiwillige

Insert eines Freiwilligen

/********************************
* $input_array eines UserInputs
* z.B.
*
* SetupInfos
* $input_array['init']['agencyID']='52'; // AgenturID
* $input_array['init']['accessKey']='xxxxxxxxx'; // AccessKey
* Infos zum User
* $input_array['entity']['vorname']='Jan';
* $input_array['entity']['nachname']='Rademacher';
* AdressDaten
* $input_array['entity']['address']['adress_strasse']='Am Musterweg';
* $input_array['entity']['address']['adress_plz']='26135';
* $input_array['entity']['address']['adress_ort']='Oldenburg';
* Sonstige Infos
* $input_array['entity']['unsupported'][]='Informationen, Informationen, für die es bei Freinet keine ›Entsprechung‹ gibt. (Die Informationen werden gesondert angezeigt)';
* Protokoll
* $input_array['protokoll'][1]['title']='Mein Protokoll';
* $input_array['protokoll'][1]['content']='Mein Protokollinhalt';
* $input_array['protokoll'][1]['date']='2020-12-29';
*/
$input_array['init']['apiVersion']='1.0';
$input_array['init']['agencyID']='52';
$input_array['init']['accessKey']='xxxxxxxxx';
$input_array['init']['modul']='personen'; // TargetModul freiwillige|einrichtung|angebot|kontakte

$input_array['init']['author']='Muster e.V.'; // TargetModul freiwillige|einrichtung|angebot|kontakte
$input_array['init']['author_mail']='mail@muster_e_V.de'; // TargetModul freiwillige|einrichtung|angebot|kontakte

$input_array['entity']['anrede']='Herr'; // (mixed) Herr|Frau|1|2  (1==Herr, 2==Frau)
$input_array['entity']['titel']='Dr.'; // Prof. Dr.
$input_array['entity']['vorname']='Rudi';
$input_array['entity']['nachname']='Dutschke';


/*********************************
* Versand via cURL
*/
$url='https://freinet-online.de/api/input/v3/personen';

$ch=curl_init($url);

# Setup request to send json via POST.
$payload=json_encode($input_array,JSON_PRETTY_PRINT);

curl_setopt($ch,CURLOPT_POSTFIELDS,$payload);
curl_setopt($ch,CURLOPT_HTTPHEADER,array('Content-Type:application/json'));
# Return response instead of printing.
curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);
# Send request.
$result=curl_exec($ch);
curl_close($ch);
		
Key-Value Elemente einer Agentur filtern

Sie können sich hier eine Liste von Elementen anzeigen lassen, um für die API einige Schlüssel zu erhalten.