OSCam/en/XML API - Versionsgeschichte

Don de Deckelwech: /* Introduction */ added forum-thread

2013-12-31T18:49:45Z

Introduction: added forum-thread

← Nächstältere Version		Version vom 31. Dezember 2013, 18:49 Uhr
Zeile 12:		Zeile 12:


	[[Datei:MessageS.png\|text-bottom]] '''NOTE:''' The XML API is still under development. The information on this page is valid with version ''OSCAM 1.00-unstable_svn build #4641''.		[[Datei:MessageS.png\|text-bottom]] '''NOTE:''' The XML API is still under development. The information on this page is valid with version ''OSCAM 1.00-unstable_svn build #4641''. This is the according thread in the forum: http://www.streamboard.tv/wbb2/thread.php?threadid=30478 .

	=== Overview ===		=== Overview ===

Admin am 23. Juli 2012 um 00:46 Uhr

2012-07-23T00:46:37Z

← Nächstältere Version		Version vom 23. Juli 2012, 00:46 Uhr
Zeile 27:		Zeile 27:
	/oscamapi.html?part=entitlement&label=<readername>		/oscamapi.html?part=entitlement&label=<readername>

	User statistics (since [~~http~~:~~//streamboard.gmc.to:8001~~/changeset/4835/trunk ~~#4835~~])		User statistics (since [[Streamboard:oscam/changeset/4835/trunk\|r4835]])
	/oscamapi.html?part=userstats		/oscamapi.html?part=userstats
	or		or

Wiwe am 19. März 2011 um 18:59 Uhr

2011-03-19T18:59:27Z

← Nächstältere Version		Version vom 19. März 2011, 18:59 Uhr
Zeile 1:		Zeile 1:
	[[Kategorie:OSCam]]		[[Kategorie:OSCam]]
	{{OSCamHomeLinks}}		{{OSCamHomeLinks}}

			<span style="background-color:Blue;color:White;padding:0 5px;">ÄNDERUNG - CHANGE - MODIFICATIONS - MODIFICA svn4835:03/19/2011</span>

	== XML API ==		== XML API ==

ValD: Added new API, userstats

2011-03-19T18:37:47Z

Added new API, userstats

@@ Zeile 24: / Zeile 24: @@
 Reader Entitlement (only cccam readers for now):
   /oscamapi.html?part=entitlement&label=<readername>
 For any errors, an error response is returned (in valid XML):
@@ Zeile 108: / Zeile 113: @@
           </ecmstats>
       </reader>
   </oscam>

ValD: Removed the German language warning.

2011-03-16T02:14:17Z

Removed the German language warning.

← Nächstältere Version		Version vom 16. März 2011, 02:14 Uhr
Zeile 1:		Zeile 1:
	[[Kategorie:OSCam]]		[[Kategorie:OSCam]]
	{{OSCamHomeLinks}}		{{OSCamHomeLinks}}

	~~[[Datei:WarningS.png\|text-bottom]] '''Attention:''' The content of the english pages are partially still in german. Please register here to help us completing and translating the articles.~~

	== XML API ==		== XML API ==

ValD: Translated to English.

2011-03-15T23:49:42Z

Translated to English.

← Nächstältere Version		Version vom 15. März 2011, 23:49 Uhr
Zeile 5:		Zeile 5:

	== XML API ==		== XML API ==
	=== ~~Intro~~ ===		=== Introduction ===
	OSCam ~~beinhaltet auch eine~~ [http://de.wikipedia.org/wiki/~~Programmierschnittstelle~~ API] (Application Programming Interface), ~~die z~~.B. ~~für Imagebauer, Plugin-Entwickler, etc., von großem Nutzen sein kann~~.		OSCam also offers an [http://en.wikipedia.org/wiki/Web_service API] (Application Programming Interface), which could be very useful for querying the server from an application, e.g. plugins.
	~~Der Zugriff auf die~~ API ~~erfolgt per~~ [http://de.wikipedia.org/wiki/~~Hypertext_Transfer_Protocol~~ http] ~~oder~~ [http://de.wikipedia.org/wiki/~~Hypertext_Transfer_Protocol_Secure~~ https].		The API can be accessed through [http://en.wikipedia.org/wiki/Http http] or [http://en.wikipedia.org/wiki/Https https].

	~~Kurzum~~: ~~Mit der~~ XML API ~~können~~ OSCam~~-Informationen, wie z.B.~~ ''version'', ''starttime'', ''uptime'', ~~..., sowie auch OSCam-Stati, ausgewertet werden~~.		In a nutshell: the XML API can be used to query OSCam about various parameters (''version'', ''starttime'', ''uptime''), and statistics.


	[[Datei:MessageS.png\|text-bottom]] '''~~Info~~:''' ~~Die~~ XML API ~~ist selbst noch in der Entwicklung~~. ~~Nachfolgende Informationen wurden mit~~ ''OSCAM 1.00-unstable_svn build #4641'' ~~gesammelt~~.		[[Datei:MessageS.png\|text-bottom]] '''NOTE:''' The XML API is still under development. The information on this page is valid with version ''OSCAM 1.00-unstable_svn build #4641''.

	=== ~~Übersicht~~ ===		=== Overview ===
	Status ~~ohne~~ Log:		Status without Log:
	/oscamapi.html?part=status		/oscamapi.html?part=status

	Status ~~mit~~ Log:		Status with Log:
	/oscamapi.html?part=status&appendlog=1		/oscamapi.html?part=status&appendlog=1

	~~Readerstatus mit~~ EMM ~~und~~ LB ~~Stats~~:		Reader status with EMM and LB statistics:
	/oscamapi.html?part=readerstats&label=<readername>		/oscamapi.html?part=readerstats&label=<readername>

	Reader Entitlement (~~momentan nur~~ cccam ~~reader - Karten~~):		Reader Entitlement (only cccam readers for now):
	/oscamapi.html?part=entitlement&label=<readername>		/oscamapi.html?part=entitlement&label=<readername>

	~~Bei falschem Aufruf sollte überall eine auswertbare~~ XML ~~Fehlermeldung kommen~~:		For any errors, an error response is returned (in valid XML):
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<oscam version="1.00-unstable_svn build #4437" starttime="2011-01-12T23:44:35+0100" uptime="124500" >		<oscam version="1.00-unstable_svn build #4437" starttime="2011-01-12T23:44:35+0100" uptime="124500" >
Zeile 33:		Zeile 33:
	</oscam>		</oscam>

	[[Datei:MessageS.png\|text-bottom]] '''~~Info~~:''' ~~Datumsangaben sind~~ in ISO ~~- Zeitangaben in integer Sekunden~~		[[Datei:MessageS.png\|text-bottom]] '''NOTE:''' Dates are represented in ISO, durations are integers (no of seconds)

	=== ~~Beispielausgaben~~ ===		=== Example Responses ===
	Status ~~ohne~~ Log '''''/oscamapi.html?part=status''''':		Status without Log '''''/oscamapi.html?part=status''''':
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<oscam version="1.00-unstable_svn build #4641" starttime="2011-01-28T16:00:17+0100" uptime="643" >		<oscam version="1.00-unstable_svn build #4641" starttime="2011-01-28T16:00:17+0100" uptime="643" >
Zeile 84:		Zeile 84:
	</oscam>		</oscam>

	~~Readerstatus mit~~ EMM ~~und~~ LB ~~Stats~~ '''''/oscamapi.html?part=readerstats&label=<readername>'''''		Reader status with EMM and LB statistics '''''/oscamapi.html?part=readerstats&label=<readername>'''''
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<oscam version="1.00-unstable_svn build #4641" starttime="2011-01-28T16:00:17+0100" uptime="1718" >		<oscam version="1.00-unstable_svn build #4641" starttime="2011-01-28T16:00:17+0100" uptime="1718" >
Zeile 112:		Zeile 112:
	</oscam>		</oscam>

	=== XML-Parsing: PHP-~~Beispiel~~ ===		=== XML-Parsing: PHP-Example ===
	<?php		<?php
	# OSCam XML API example in PHP		# OSCam XML API example in PHP

Wiwe am 5. Februar 2011 um 12:54 Uhr

2011-02-05T12:54:12Z

← Nächstältere Version		Version vom 5. Februar 2011, 12:54 Uhr
Zeile 1:		Zeile 1:
	[[Kategorie:OSCam]]		[[Kategorie:OSCam]]
	{{OSCamHomeLinks}}		{{OSCamHomeLinks}}

	[[Datei:WarningS.png\|text-bottom]] '''Attention:''' The content of the english pages are partially still in german. Please register here to help us completing and translating the articles.		[[Datei:WarningS.png\|text-bottom]] '''Attention:''' The content of the english pages are partially still in german. Please register here to help us completing and translating the articles.

Wiwe am 5. Februar 2011 um 12:53 Uhr

2011-02-05T12:53:41Z

← Nächstältere Version		Version vom 5. Februar 2011, 12:53 Uhr
Zeile 1:		Zeile 1:
	[[Kategorie:OSCam]]		[[Kategorie:OSCam]]
	{{OSCamHomeLinks}}		{{OSCamHomeLinks}}
			[[Datei:WarningS.png\|text-bottom]] '''Attention:''' The content of the english pages are partially still in german. Please register here to help us completing and translating the articles.

	== XML API ==		== XML API ==

Wiwe: Die Seite wurde neu angelegt: „Kategorie:OSCam {{OSCamHomeLinks}} == XML API == === Intro === OSCam beinhaltet auch eine [http://de.wikipedia.org/wiki/Programmierschnittstelle API] (Applic...“

2011-01-28T21:05:21Z

Die Seite wurde neu angelegt: „Kategorie:OSCam {{OSCamHomeLinks}} == XML API == === Intro === OSCam beinhaltet auch eine [http://de.wikipedia.org/wiki/Programmierschnittstelle API] (Applic...“

Neue Seite

[[Kategorie:OSCam]]
{{OSCamHomeLinks}}

== XML API ==
=== Intro ===
OSCam beinhaltet auch eine [http://de.wikipedia.org/wiki/Programmierschnittstelle API] (Application Programming Interface), die z.B. für Imagebauer, Plugin-Entwickler, etc., von großem Nutzen sein kann.
Der Zugriff auf die API erfolgt per [http://de.wikipedia.org/wiki/Hypertext_Transfer_Protocol http] oder [http://de.wikipedia.org/wiki/Hypertext_Transfer_Protocol_Secure https].

Kurzum: Mit der XML API können OSCam-Informationen, wie z.B. ''version'', ''starttime'', ''uptime'', ..., sowie auch OSCam-Stati, ausgewertet werden.

[[Datei:MessageS.png|text-bottom]] '''Info:''' Die XML API ist selbst noch in der Entwicklung. Nachfolgende Informationen wurden mit ''OSCAM 1.00-unstable_svn build #4641'' gesammelt.

=== Übersicht ===
Status ohne Log:
/oscamapi.html?part=status

Status mit Log:
/oscamapi.html?part=status&appendlog=1

Readerstatus mit EMM und LB Stats:
/oscamapi.html?part=readerstats&label=<readername>

Reader Entitlement (momentan nur cccam reader - Karten):
/oscamapi.html?part=entitlement&label=<readername>

Bei falschem Aufruf sollte überall eine auswertbare XML Fehlermeldung kommen:
<?xml version="1.0" encoding="UTF-8"?>
<oscam version="1.00-unstable_svn build #4437" starttime="2011-01-12T23:44:35+0100" uptime="124500" >
<error>part not found</error>
</oscam>

[[Datei:MessageS.png|text-bottom]] '''Info:''' Datumsangaben sind in ISO - Zeitangaben in integer Sekunden

=== Beispielausgaben ===
Status ohne Log '''''/oscamapi.html?part=status''''':
<?xml version="1.0" encoding="UTF-8"?>
<oscam version="1.00-unstable_svn build #4641" starttime="2011-01-28T16:00:17+0100" uptime="643" >
<status>
<client type="s" name="root" protocol="server" protocolext="" au="0">
<request caid="0000" srvid="0000" ecmtime="0" answered=""></request>
<times login="2011-01-28T16:00:17+0100" online="643" idle="0"></times>
<connection ip="127.0.0.1" port="0">OK</connection>
</client>
<client type="h" name="root" protocol="monitor" protocolext="" au="0">
<request caid="0000" srvid="0000" ecmtime="0" answered=""></request>
<times login="2011-01-28T16:00:17+0100" online="643" idle="0"></times>
<connection ip="127.0.0.1" port="0">OK</connection>
</client>
<client type="r" name="my_reader_1" protocol="mouse" protocolext="" au="0">
<request caid="0000" srvid="0000" ecmtime="0" answered=""></request>
<times login="2011-01-28T16:00:17+0100" online="643" idle="630"></times>
<connection ip="127.0.0.1" port="0">CARDOK</connection>
</client>
<client type="r" name="my_reader_2" protocol="mouse" protocolext="" au="0">
<request caid="0000" srvid="0000" ecmtime="0" answered=""></request>
<times login="2011-01-28T16:00:17+0100" online="643" idle="629"></times>
<connection ip="127.0.0.1" port="0">CARDOK</connection>
</client>
<client type="r" name="my_reader_3" protocol="mouse" protocolext="" au="0">
<request caid="0000" srvid="0000" ecmtime="0" answered=""></request>
<times login="2011-01-28T16:00:17+0100" online="643" idle="630"></times>
<connection ip="127.0.0.1" port="0">CARDOK</connection>
</client>
<client type="c" name="cccam_2" protocol="newcamd (CCcam)" protocolext="" au="0">
<request caid="FFFE" srvid="FFFE" ecmtime="0" answered=""></request>
<times login="2011-01-28T16:00:33+0100" online="627" idle="58"></times>
<connection ip="127.0.0.1" port="43111">OK</connection>
</client>
<client type="c" name="cccam_3" protocol="newcamd (CCcam)" protocolext="" au="0">
<request caid="1702" srvid="00CA" ecmtime="0" answered="invalid"></request>
<times login="2011-01-28T16:00:33+0100" online="627" idle="23"></times>
<connection ip="127.0.0.1" port="33222">OK</connection>
</client>
<client type="c" name="cccam_1" protocol="newcamd (CCcam)" protocolext="" au="0">
<request caid="1702" srvid="00CA" ecmtime="1" answered="invalid"></request>
<times login="2011-01-28T16:00:56+0100" online="604" idle="23"></times>
<connection ip="127.0.0.1" port="40333">OK</connection>
</client>
</status>
<log><![CDATA[]]></log>
</oscam>

Readerstatus mit EMM und LB Stats '''''/oscamapi.html?part=readerstats&label=<readername>'''''
<?xml version="1.0" encoding="UTF-8"?>
<oscam version="1.00-unstable_svn build #4641" starttime="2011-01-28T16:00:17+0100" uptime="1718" >
<reader label="my_reader_1">
<emmstats totalwritten="4" totalskipped="0" totalblocked="0" totalerror="0">
<emm type="unknown" result="error">0</emm>
<emm type="unique" result="error">0</emm>
<emm type="shared" result="error">0</emm>
<emm type="global" result="error">0</emm>
<emm type="unknown" result="written">0</emm>
<emm type="unique" result="written">0</emm>
<emm type="shared" result="written">0</emm>
<emm type="global" result="written">4</emm>
<emm type="unknown" result="skipped">0</emm>
<emm type="unique" result="skipped">0</emm>
<emm type="shared" result="skipped">0</emm>
<emm type="global" result="skipped">0</emm>
<emm type="unknown" result="blocked">0</emm>
<emm type="unique" result="blocked">0</emm>
<emm type="shared" result="blocked">0</emm>
<emm type="global" result="blocked">0</emm>
</emmstats>
<ecmstats count="1" totalecm="68" lastaccess="2011-01-28T16:28:52+0100">
<ecm caid="1702" provid="000000" srvid="00DF" channelname="Bundesliga" avgtime="541" lasttime="543" rc="0" rcs="found" lastrequest="2011-01-28T16:28:52+0100">68</ecm>
</ecmstats>
</reader>
</oscam>

=== XML-Parsing: PHP-Beispiel ===
<?php
# OSCam XML API example in PHP
# USER SETUP ***********************************************
$_CONSTANTS = array(
'OSCAM_URL' => 'http://127.0.0.1:4711/oscamapi.html'
,'LOCAL_ACCESS_ONLY' => true # true = call OSCam XML API by "wget"; false = call OSCam XML API by URL - default = true
,'NL' => "\n" # Newline
);
# END USER SETUP *******************************************

# define constants *****************************************
foreach($_CONSTANTS as $key => $val) {
if(is_array($_CONSTANTS[$key])) $$key = $val;
else define($key, $val);
}
# save memory...
unset($_CONSTANTS);

# private vars *********************************************
define('PART_NAME', 'part');

# OSCam class **********************************************
class OSCam {
public function getXMLfile($part) {
$r = null;
if(LOCAL_ACCESS_ONLY) {
$r = trim(shell_exec('wget -O - "'.OSCAM_URL.'?'.PART_NAME.'='.$part.'"'));
} else {
$r = file_get_contents(OSCAM_URL.'?'.PART_NAME.'='.$part);
}
return $r;
}

public function getStatusNumOfType(&$xml, $nType) {
$r = 0;
$x = new SimpleXMLElement($xml);
foreach($x->status->client as $c) {
if(!empty($c['type']) && $c['type'] == $nType) $r++;
}
return $r;
}
}

# OUTPUT-EXAMPLES ******************************************
$oc = new OSCam;

# status
$xml = $oc->getXMLfile('status');

echo NL.'<h1>XML status content:</h1>'.NL;
echo '<pre>'.htmlspecialchars($xml).'</pre>';

echo NL.'<h1>Number of readers:</h1>'.NL;
$t = $oc->getStatusNumOfType($xml, 'r');
echo '<pre>'.$t.'</pre>';

echo NL.'<h1>Number of active clients:</h1>'.NL;
$t = $oc->getStatusNumOfType($xml, 'c');
echo '<pre>'.$t.'</pre>';

?>

{{OSCamTranslatedLinks}}