API & Widgets

So ein Portal lebt und hilft den Menschen nur mit entsprechend großer Reichweite. Dazu haben wir eine Möglichkeit geschaffen, von der alle profitieren können. Es gibt viele Webseitenbetreiber die auch helfen und unterstützen möchten, denen aber das technische Know-How oder die Mittel fehlen, eine derartige Oberfläche bereitzustellen. Und hier kommen unsere RESTful API sowie unsere Widgets ins Spiel.

RESTful API Standard

Wir arbeiten mit dem RESTful API Standard, um größtmögliche Kompatibilität zu bieten und es jedem Programmierer und auch Webseitenbetreiber zu ermöglichen, die Daten unseres Portales auf seiner eigenen Seite auszugeben. Das hat den Vorteil, dass man sich nicht selbst um die technische Verwaltung der Angebote und Gesuche kümmern muss und immer Zugriff in Echtzeit auf einen großen Datenbestand hat. Natürlich hast du als Webseitenbetreiber den Überblick und die entsprechenden Eingriffsmöglichkeiten bei den Einträgen, die über deine Seite generiert werden.
Und das Beste: man kann sich damit einen eigenen „Marktplatz“ zu dem Thema aufbauen, weil man schon beim Abfragen der Daten z.B. nach PLZ oder Ort filtern kann und seinen Nutzern dann nur relevante (lokale) Inhalte ausspielt.

zum Hilfsportal von gemeinsam-jetzt.de

Offene API mit Widget für jede Webseite

Wenn du Einträge aus unserem Portal auf deiner Webseite zeigen willst, dann musst du einfach diesen Code kopieren und an der gewünschten Stelle auf deiner Webseite einfügen. Die Nutzung der offenen (public) API steht jedem zur Verfügung.

Copy to Clipboard

Private API mit Widget mit mehr Funktionen

Wenn du unsere private API mit mehr Funktionen nutzen willst, brauchst du dafür einen API-Key. Du kannst dann z.B. deine eigenen Einträge auf deiner Webseite generieren, verwalten und z.B. auch nur diese anzeigen.
Bitte schreibe uns eine E-Mail an support@gemeinsam-jetzt.de wenn du daran Interesse hast. Teile uns dein Vorhaben sowie deine Webseite mit, auf der du unsere API nutzen möchtest. Wir werden dann umgehend Kontakt mit dir aufnehmen.

Copy to Clipboard

Verfügbare Widget Optionen für offene und private API

apiAccess
– Type: String
– Default: ‚public‘
– Required: false
– Possible Values: ‚public‘, ‚private‘
– Description: Defines the endpoint to use: public or private API

apiToken
– Typ: String
– Default: null
– Required: false
– Description: Personal API token for private API

type
– Type: String
– Default: null
– Required: true
– Possible Values: ‚offers‘, ‚requests‘
– Description: Listing should show offers or requests

perPage
– Type: Number
– Default: 50
– Required: false
– Description: Number of results per page

pagination
– Type: Boolean
– Required: false
– Default: true
– Description: Show pagination yes / no

contactForm
– Type: Boolean
– Required: false
– Default: true
– Description: Show contact form yes / no

search
– Type: Boolean
– Required: false
– Default: true
– Description: Show search yes / no

searchFacets
– Type: Boolean
– Required: false
– Default: true
– Description: Show search filters / facets yes / no

canCreate
– Type: Boolean
– Required: false
– Default: false
– Description: Show create form yes / no. Only possible with private API.

zip
– Type: Array of Strings
– Required: false
– Default: null
– Description: Pre-filter results by ZIP codes

conditionsUrl
– Type: String
– Required: false
– Default: null
– Description: URL to privacy policy

bgMode
– Type: String
– Required: false
– Default: ‚gray‘
– Possible Values: ‚gray‘, ‚white‘
– Description: Defines the coloring of the boxes (white / gray) based on the defined background color.

Widgets – für die ganz bequemen

Für all diejenigen, die so gut wie keine Programmierkenntnisse haben oder einfach nur bequem sind 😉 , bieten wir fertige Widgets zum integrieren in die eigene Webseite an. Diese Integrationen können sogar mit kompletten Formularen wie dem Eintragen von Angeboten und Gesuchen oder eben der Kontaktaufnahme zu Helfern oder Hilfesuchenden von uns bereitgestellt werden.
Wenn du Interesse an einer derartigen Partnerschaft hast, melde dich einfach bei uns: support@gemeinsam-jetzt.de

Helfen ist so einfach

Jetzt mit Paypal unterstützen

Deine Spende erfolgt freiwillig als Unterstützung für dieses Portal. Wir sind nicht berechtigt, Spendenquittungen auszustellen.