W3Net.eu

Minden SOAP üzenet tartalmaz egy kiegészítő SOAP fejlécet (Header elem).
Az opcionális fejléc elem, a Header kiegészítő adatok megadására szolgál.
Ugyanabból a célból létezik, mint a HTTP Header. Leggyakrabban a Header elembe
a munkamenet (session) azonosítót, vagy a kliens hitelesítéséhez szükséges adatokat teszik.

Kliens

Lássuk, hogyan kell a PHP5-ben megjelent SOAP kiterjesztéssel beállítani egy SOAP fejlécet.
Tegyük fel, hogy a munkamenet azonosítot kell elküldenünk minden egyes SOAP üzenetben.
A Header elem bármilyen elemeket tartalmazhat, csakis tőlünk függ a tartalma
(na meg persze a kiszolgáló oldalon a WSDL fájlban deklaráltaktól).
A példa kedvéért a munkamenet azonosítót egy sessionId nevű elemben kell elhelyeznünk,
ami egy további ApiUserAuthHeader szülő elemben kell, hogy legyen. Ezek az elemek pedig a
urn:ExampleAPI névtérben kellenek, hogy legyenek.
Lássunk egy kész SOAP üzenetet, amit a kliens küld a kiszolgálónak.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:q0="urn:ExampleAPI" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Header> <q0:ApiUserAuthHeader> <q0:sessionId>s29e3sas5a2uiaa89aSJkapVp</q0:sessionId> </q0:ApiUserAuthHeader> </soapenv:Header> <soapenv:Body> <q0:test></q0:test> </soapenv:Body> </soapenv:Envelope>

Íme a PHP kód:

$client = new SoapClient('http://.../server/service.wsdl', array( 'style' => SOAP_DOCUMENT, 'use' => SOAP_LITERAL, 'encoding' => 'UTF-8' )); // SOAP Header beállitása class ApiUserAuthHeader { function __construct($sid){ $this->sessionId = new SoapVar($sid,XSD_STRING,NULL,NULL,'sessionId','urn:ExampleAPI'); } } $auth = new ApiUserAuthHeader('ce50f06c3f00a938ddeb78b22bb33c7192932006'); /* You MUST encode the object */ $authVar = new SoapVar($auth, SOAP_ENC_OBJECT); $header = new SoapHeader('urn:ExampleAPI', "ApiUserAuthHeader",$authVar, FALSE, SOAP_ACTOR_NEXT); $client->__setSoapHeaders(array($header)); $params = array('apiKey' => 'WorkaholicGroupApiKey', 'sig' => '0c9ed93ec403851a2f7682aceb98a5a9'); $ret = $client->login($params);

A SoapHeader osztály
szolgál SOAP fejléc létrehozására. Létre kellett hoznunk egy ApiUserAuthHeader osztályt, aminek egy
sessionId tulajdonságot adunk.

Annak ellenére, hogy a SoapHeader konstruktorában, az első paraméterrel beállítottuk az urn:ExampleAPI, a SOAP
kiterjesztés valamilyen okból mégsem ad a sessionId elemnek prefixet,
ezért volt szükség az ApiUserAuthHeader osztály konstruktorában a sessionId-t SoapVar objektummal létrehozni
(egyébként elég lett volna egy sima publikus sessionId nevű változó is).
Erről itt olvashatunk többet: http://bugs.php.net/bug.php?id=40318&edit=1.

A login metódusnak a paramétereket így is átadhattuk volna, ez is helyes megoldás:
class login{ public $apiKey; public $sig; } $parameters = new login(); $parameters->apiKey = 'WorkaholicGroupApiKey'; $parameters->sig = '0c9ed93ec403851a2f7682aceb98a5a9'; $ret = $client->login($parameters);

Ha viszont így hívtuk volna meg a login metódust, akkor a SOAP kiterjesztés helytelenül kódolta volna a paramétereket a SOAP törzsben.

$ret = $client->__call('login',array('WorkaholicGroupApiKey','0c9ed93ec403851a2f7682aceb98a5a9'));

<SOAP-ENV:Body> <ns1:login/> <param1>0c9ed93ec403851a2f7682aceb98a5a9</param1> </SOAP-ENV:Body>

Kiszolgáló

Kiszolgáló oldalon a következőkre van szükségünk:

Elkapni a beérkezett SOAP XML üzenetet

$request = file_get_contents('php://input'); 

Kiparszolni belőle a sessionId elem tartalmát

// parse request XML $oDom = new DomDocument('1.0', 'UTF-8'); $oDom->preserveWhiteSpace = false; $bResult = $oDom->loadXML($request/*,LIBXML_NOWARNING*/); if ($bResult === FALSE){ // throw SOAP fault 'Invalid XML request received.' } // check sessionID in the header $sessionId = ''; $oXpath = new DomXPath($oDom); $oXpath->registerNamespace('n','urn:ExampleAPI'); $oNodeList = $oXpath->query('//*/n:ApiUserAuthHeader/n:sessionId'); if ($oNodeList->length == 1){ $sessionId = (string)$oNodeList->item(0)->childNodes->item(0)->nodeValue; } if (empty($sessionId)){ // throw SOAP fault if sessionID is not present in the header of the request message ... }

Linkek

• Kliens kipróbálása,
  forrás
• rosszul működő kliens kipróbálása,
  forrás