Freinet Online
64342 Burkhardtstraße 24
Seeheim-JugenheimGermany

Tel: +49 6257 - 5037290
.

Portal-API

Mittels unserer Portal-API können Sie die veröffentlichten Datensätze eines Engagement-Portals auslesen, um sie z.B. auf Ihrer Homepage zu präsentieren.
Im Gegensatz zur Angebot-API ermöglicht die Portal-API den Zugriff auf mehrere KundenDaten (›Freiwilligenagenturen‹)

Das Beispiel-Skript welches Sie hier zum Download finden, ist umfangreich kommentiert.
Wenn Sie Fragen haben, können Sie uns gerne kontaktieren.

[download coming soon]
 

Dokumentation

Einführung

Unsere Angebot-API bietet drei Endpoints, mittels denen die Daten abgeholt werden können.

1) "CriteriaServiceEndpoint" - Die Abfrage der Matching-Kategorien und Kriterien (zum erzeugen der Filter)

2) "MatchingServiceEndpoint" - Die Listenansicht der veröffentlichten Angebote

3) "OfferServiceEndpoint" - die Detailansicht eines veröffentlichten Angebotes

Übersicht der Parameter

Bsp

CriteriaServiceEndpoint

Endpoint für die Matchingkategorien und -kriterien
www.lachnit-software.de/query/api/portal/v1/CriteriaServiceEndpoint.php
portalId
(int)
[required]
ID des Portals in dem die Agentur Angebote veröffentlichen
accessKey
(string)
[required]
ApiAccessKey
Optionale Parameter
matching_category_filter
(string)
Um nicht alle Kategorien erzeugen zu müssen, können Sie die notwendigen Kategorien filtern. Nicht notwendig, aber ressourcenschonend.
Bsp

MatchingServiceEndpoint

Endpoint für die Listenansicht der Angebote
https://www.lachnit-software.de/query/api/portal/v1/MatchingServiceEndpoint.php
portalId
(int)
[required]
ID der Portals
accessKey
(string)
[required]
ApiAccessKey
Optionale Parameter
accessKeyInternal
(string)
Um erweiterten Zugriff auf Angebote zu bekommen, benötigen Sie den internen AccessKey. Damit haben Sie Zugriff auch auf „nicht veröffentlichte Angebote“
MatchingKategorien,
(int, CSV)

z.B.
- arbeitsweisen
- zielgruppen
- handlungsfelder
- globalbereiche
- mtffa(1-6)
CSV z.B:
&arbeitsweisen=1,5,155

Freinet bietet ca 30 mögliche Kategorien an.
Welche Sie im einzelnen nutzen können, erfahren Sie von Ihrer Freiwilligenagentur
plz
(int)

Umkreis
(int)
Int in km
projekt_id_inc
(int, CSV)
CSV Liste von ProjektID´s, in denen die Angebote „Teilnehmern“ sein müssen
(bekommen sie bei Bedarf von der Freiwilligenagentur)
projekt_id_ex
(int, CSV)
CSV Liste, von ProjektID´s, in denen die Angebote NICHT sein dürfen
(bekommen sie bei Bedarf von der Freiwilligenagentur)
suchmodus
(string)
wenn „und“ übergeben wird, werden die MatchingKategorien „Und“ verknüpft
suchbegriff
(string)
Freitextsuche
Die Freitextsuche unterstützt die Begriffe ›UND‹, ›NICHT‹ und Anführungszeichen ““ um Begriffe einzuschliessen.
match_for_organisation
(integer)
Matching nach Einrichtungen
Wenn match_for_organisation=1, wird das Matching nach Einrichtungen durchgeführt
startdatum_von
(DATE_ISO8601)
DATE_ISO8601
zum einschränken von zeitlich limitierten Engagements
startdatum_bis
(DATE_ISO8601)
DATE_ISO8601
startdatum
(DATE_ISO8601)
DATE_ISO8601|DATE_ISO8601
Alternative Möglichkeit, die Zeiten zu filtern.
Hier müssen Sie Start- und EndDatum durch den senkrechten Strich („Pipe“) verbinden.

publishing_status
(string)
Nur in Verbindung mit Parameter „AccessKeyInternal“ um auch auf nicht öffentliche Angebote zuzugreifen.
(Nur in speziellen Anforderungen und mit Rücksprache)
PUBLISHED; UNPUBLISHED; ALL
page
(int)
SeitenZahl
limit
(int)
Limit, z.B:
&page=2&limit=10&page=3
sortierung
(string)
- wertigkeit (Standard): In Kombination mit Matchingfiltern werden die besten Angebote ›oben‹ angezeigt
   Alle übrigen Angebote werden nach ›zuletzt bearbeitet‹ angezeigt.
- angebot_name_ASC: Angebotstitel ⇑ aufsteigend
- angebot_name_DESC: Angebotstitel ⇓ absteigend
- einrichtung_name_ASC: Einrichtungstitel ⇑ aufsteigend
- einrichtung_name_DESC: Einrichtungstitel ⇓ absteigend
- dateline: Datum
- termine_ASC: Termine ⇑ aufsteigend
- termine_DESC: Termine ⇓ absteigend
Bsp

OfferServiceEndpoint

Endpoint für die Detailansicht eines Angebots
www.lachnit-software.de/query/api/portal/v1/OfferServiceEndpoint.php
portalId
(int)
[required]
ID der Agentur
accessKey
(string)
[required]
ApiAccessKey
offerId
(int)
[required]
Id des Angebotes