Einleitung

API


Dies ist die Beschreibung der Programmierschnittstelle oder API (Application Programming Interface)

Die API kann REST, XML-RPC und SOAP

Um die API nutzen zu können benötigen sie einen API Key. Den erhalten Sie wenn über die Mehrwert Initiative, wenn Ihr Unternehmen in 2014 an dem Event teilnimmt. Die API ist für die Entwickler gedacht, die auch die IT der Unternehmen betreuen (z.B. das Intranet mit der Intranet Version der Wer-radelt-am-meisten Aktion). Die API und der CODE sind nicht für End-Anwender gedacht.

REST

Um die Daten zu übertragen können Sie einen Browser benutzen oder programmatisch (per wget, curl o.ä.) die Daten übertragen.

REST steht für REpresentational State Transfer

Der Output kann per JSON, PHP oder XML erfolgen

REST-JSON

https://wer-radelt-am-meisten.de/api/rest/search_entry/json?auth[api_key]=...&data[channel]=gesamtkilometer_und_teilnehmer

REST-PHP

https://wer-radelt-am-meisten.de/api/rest/search_entry/php?auth[api_key]=...&data[channel]=gesamtkilometer_und_teilnehmer

REST-XML

https://wer-radelt-am-meisten.de/api/rest/search_entry/xml?auth[api_key]=...&data[channel]=gesamtkilometer_und_teilnehmer

SOAP

Service only

https://wer-radelt-am-meisten.de/api/soap

WSDL only

https://wer-radelt-am-meisten.de/api/soap?wsdl

XML-RPC

https://wer-radelt-am-meisten.de/api/xmlrpc

Übertragen von Daten

create_entry : Übermitteln von Gesamtkilometern Ihres Unternehmens und der Teilnehmer-Anzahl

Die Paramter:

https://wer-radelt-am-meisten.de/api/rest/create_entry/json?auth[api_key]=...&data[title]=keins&data[channel_name]=gesamtkilometer_und_teilnehmer&data[site_id]=1&data[anzahl_teilnehmer]=100&data[gesamt_kilometer]=101&data[km_fahrer_firma]=1

create_entry : Übermitteln von Teams

Die Parameter

https://wer-radelt-am-meisten.de/api/rest/create_entry/json?auth[api_key]=...&data[title]=keins&data[channel_name]=teams&data[site_id]=1&data[team_von_firma]=1&data[interne_team_id]=9&data[team_gesamtkilometer]=160

read_entry: Lesen eines Datensatzes

Die Parameter:

https://wer-radelt-am-meisten.de/api/rest/read_entry/json?auth[api_key]=...&data[entry_id]=12345

update_entry: Ändern eines Datensatzes

Die Paramter:

https://wer-radelt-am-meisten.de/api/rest/update_entry/json?auth[api_key]=...&data[entry_id]12345=&data[title]=wert&data[anzahl_teilnehmer]=100&data[gesamt_kilometer]=101

search_entry: Suchen eines Datensatzes

Die Parameter:

https://wer-radelt-am-meisten.de/api/rest/search_entry/json?auth[api_key]=...&data[channel]=gesamtkilometer_und_teilnehmer

SOAP

Ein PHP Code Beispiel zum Übertragen der Firmen-Gesamtkilometer

<?php
$client = new SoapClient('https://wer-radelt-am-meisten.de/api/soap?wsdl', array('trace' => 1));

$reponse = $client->create_entry(array(
	'api_key' => 'xxxxx'),
array(
	'channel_name' => 'gesamtkilometer_und_teilnehmer',
	'title' => 'test entry',
        'km_fahrer_firma' => '1',
        'anzahl_teilnehmer' => '100',
        'gesamt_kilometer' => '100'
));

print_r($reponse);
?>

Ein PHP Code Beispiel zum Übertragen der Firmen-Gesamtkilometer

<?php
$client = new SoapClient('https://wer-radelt-am-meisten.de/api/soap?wsdl', array('trace' => 1));

$reponse = $client->create_entry(array(
	'api_key' => 'xxxxx'),
array(
	'channel_name' => 'gesamtkilometer_und_teilnehmer',
	'title' => 'test entry',
        'km_fahrer_firma' => '1',
        'anzahl_teilnehmer' => '100',
        'gesamt_kilometer' => '100'
));

print_r($reponse);
?>