PHP SOAP Server mit WSDL und API Schlüssel

Diese Seite verwendet Cookies. Durch die Nutzung unserer Seite erklären Sie sich damit einverstanden, dass wir Cookies setzen. Weitere Informationen

  • In diesem Tutorial wird die Einrichtung eine kennwortgeschützten SOAP Servers mit WSDL Unterstützung erklärt.
    In diesem Tutorial wird die Einrichtung eine kennwortgeschützten SOAP Servers mit WSDL Unterstützung erklärt.

    Damit wir den SOAP Server erweitern können, erstellen wir erstmal eine Kindklasse vom SOAP Server. Dieser bringen wir nichts weiteres bei als die WSDL Funktion.
    An der WSDL Funktion scheitern leider die meisten Implementierungen. Sie gibt die Spezifikationen vor, die es ermöglichen einen SOAP Server auch mit anderen Clients zu nutzen - wie z.B. Java.

    == SOAP Server ==

    Quellcode

    1. /**
    2. * Extends SoapServer with wsdl
    3. */
    4. class APIServer extends SoapServer {
    6. /**
    7. * use reflection api to print supported methods
    8. */
    9. public function wsdl() {
    10. $url = 'http://'.$_SERVER['HTTP_HOST'].$_SERVER['PHP_SELF'];
    12. $className = 'APIService';
    13. $messageMethods = '';
    14. $portTypeOperations = '';
    15. $bindingOperations = '';
    16. $class = new ReflectionClass($className);
    18. $methods = $class->getMethods();
    19. foreach($methods as $methodKey => $methodValue) {
    20. if(!$methodValue->isPublic()) continue;
    21. $messageMethodParts = '';
    22. $params = $methodValue->getParameters();
    23. foreach($params as $paramKey => $paramValue) {
    24. $messageMethodParts .= ' <part name="'.$paramValue->name.'" type="xsd:anyType"/>';
    25. }
    26. $messageMethods .= ' <message name="'.$methodValue->name.'Request">
    27. '.$messageMethodParts.'
    28. </message>
    29. <message name="'.$methodValue->name.'Response">
    30. <part name="Result" type="xsd:anyType"/>
    31. </message>';
    32. $portTypeOperations .= ' <operation name="'.$methodValue->name.'">
    33. <input message="tns:'.$methodValue->name.'Request"/>
    34. <output message="tns:'.$methodValue->name.'Response"/>
    35. </operation>';
    36. $bindingOperations .= ' <operation name="'.$methodValue->name.'">
    37. <soap:operation soapAction="urn:xmethods-delayed-quotes#'.$methodValue->name.'"/>
    38. <input>
    39. <soap:body use="encoded" namespace="urn:xmethods-delayed-quotes" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
    40. </input>
    41. <output>
    42. <soap:body use="encoded" namespace="urn:xmethods-delayed-quotes" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
    43. </output>
    44. </operation>';
    45. }
    47. $s = '<?xml version ='."'".'1.0'."'".' encoding='."'".'UTF-8'."'".' ?>
    48. <definitions name="'.$className.'"
    49. targetNamespace="'.$url.'"
    50. xmlns:tns="'.$url.'"
    51. xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
    52. xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    53. xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
    54. xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    55. xmlns="http://schemas.xmlsoap.org/wsdl/">
    57. '.$messageMethods.'
    58. <portType name="'.$className.'PortType">
    59. '.$portTypeOperations.'
    60. </portType>
    61. <binding name="'.$className.'Binding" type="tns:'.$className.'PortType">
    62. <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
    63. '.$bindingOperations.'
    64. </binding>
    65. <service name="'.$className.'Service">
    66. <port name="'.$className.'Port" binding="tns:'.$className.'Binding">
    67. <soap:address location="'.$url.'"/>
    68. </port>
    69. </service>
    70. </definitions>';
    72. header("Content-Type: text/xml");
    73. header(sprintf("Content-Length: %d", strlen($s)));
    74. echo $s;
    75. }
    76. }
    Alles anzeigen


    == SOAP Authentifizierung ==
    Wir werden den eigentlich SOAP Service kapseln. Jeder Aufruf muss einen SOAP Header zur Authentifizierung enthalten.
    Im Beispiel muss ein SOAP Header mit dem Namen "apikey" angegeben werden. Der einzig mögliche Wert im Beispiel ist "hello".
    Diese Stelle kann natürlich durch ein komplexeren Authentifizierungsverfahren ersetzt werden. So könnt ihr auch einige Funktionen gar nicht erlauben.

    Quellcode

    1. <?php
    3. /**
    4. * API Service base system with authentification
    5. */
    6. class APIServiceAuth {
    7. private $auth = false;
    9. /**
    10. *
    11. */
    12. public function __construct() {
    13. $this->apiservice = new APIService();
    14. }
    16. /*
    17. * Authentication function
    18. * This is called by the Soap header of the same name. The function name is a Ws-security standard auth tag
    19. * and corresponds to the header tag.
    20. */
    21. public function APIToken($apikey) {
    22. $this->apikey = is_object($apikey) ? $apikey->apikey : $apikey;
    24. if($this->apikey == 'hello') {
    25. $this->auth = true;
    26. } else {
    27. $this->auth = false;
    28. }
    29. }
    31. /**
    32. * wrapper for real api service - checks authentication first
    33. *
    34. * @param function string
    35. * @param arguments mixed[]
    36. */
    37. public function __call($function, $arguments) {
    39. // authenticated
    40. if(!$this->auth) {
    41. $this->mismatchlog($function, $arguments);
    42. throw new SoapFault("Server", "Authentication error.");
    43. }
    45. // function exists
    46. if (method_exists($this->apiservice, $function)) {
    47. return call_user_func_array(array($this->apiservice, $function), $arguments);
    48. }
    49. else {
    50. throw new SoapFault("Server", "Call to undefined Method.");
    51. }
    52. }
    53. }
    Alles anzeigen


    == SOAP Service ==
    Der SOAP Service bietet die Implementierung aller Funktionen an, die ihr für öffentliche Aufrufe erlauben wollt.

    Quellcode

    1. <?php
    3. /**
    4. * API Service
    5. */
    6. class APIService {
    8. /**
    9. * gets foo
    10. */
    11. public function getFoo($param1, $param2) {
    12. return 'hello '.$param1.' / '.$param2;
    13. }
    15. /**
    16. * sets foo
    17. */
    18. public function setFoo($param1, $param2) {
    20. }
    21. }
    Alles anzeigen


    == http server ==
    Damit das ganze aufrufbar wird, muss nun alles zusammengefügt werden:

    Quellcode

    1. <?php
    2. require_once('APIServer.php');
    3. require_once('APIService.php');
    4. require_once('APIServiceAuth.php');
    6. $server = new APIServer(null, array(
    7. 'uri' => 'demo.easy-coding.de')
    8. );
    10. // output wsdl specs
    11. if(isset($_GET['wsdl'])) {
    12. $server->wsdl();
    13. }
    15. // real handler
    16. else {
    17. $server->setClass('APIServiceAuth');
    18. $server->handle();
    19. }
    Alles anzeigen


    == http client ==
    Der Client ist für unser Beispiel wie folgt zu konfigurieren:

    Quellcode

    1. <?php
    3. /*
    4. * Login credentials to be supplied as a SOAP header
    5. * Class used to ensure Soap Head tags in correct format.
    6. */
    7. class SoapHeaderAPIToken {
    8. public $apikey;
    10. /**
    11. *
    12. * @param apikey
    13. */
    14. public function __construct($apikey) {
    15. $this->apikey = $apikey;
    16. }
    17. }
    19. $uri = 'demo.easy-coding.de';
    20. $wsdl = 'http://demo.easy-coding.de/php/soap-server-wsdl-auth/server.php?wsdl';
    21. $location = 'http://demo.easy-coding.de/php/soap-server-wsdl-auth/server.php';
    23. // Set the login headers
    24. $wsu = 'http://schemas.xmlsoap.org/ws/2002/07/utility';
    25. $usernameToken = new SoapHeaderAPIToken('hello');
    26. $soapHeaders[] = new SoapHeader($wsu, 'APIToken', $usernameToken);
    28. $client = new SoapClient($wsdl, array(
    29. "location" => $location,
    30. "uri" => $uri
    31. ));
    32. $client->__setSoapHeaders($soapHeaders);
    34. // access the client
    35. echo $client->getFoo('a', 'b');
    Alles anzeigen


    == Demo + Download ==
    Die Demo und alle Downloads findet ihr unter
    demo.easy-coding.de/php/soap-server-wsdl-auth/client.php und demo.easy-coding.de/php/soap-server-wsdl-auth/download.zip

    19.086 mal gelesen