Royal Mail Shipping API: consulta de conexión SOAP y pem / certificados
Estoy tratando de configurar la API de Royal Mail Shipping (si alguien tiene alguna experiencia en esto, le agradecería que me ayudara).
En la documentación que proporcionan, necesito descargar un certificado (un archivo .p12) e importarlo a mi máquina Windows; esto es bastante sencillo con el 'Asistente de importación de certificados'. Una vez que llegue al "Establecer nivel de seguridad", debo seleccionarAlto & esto solicitará permiso con una contraseña cada vez que se use.
En Internet Explorer en 'Opciones de Internet' dentro de la pestaña Contenido, puedo ver los Certificados y puedo ver claramente que este certificado ha sido importado y no ha expirado.
El siguiente paso esextraer los componentes del certificado, aquí tengo que ejecutar los tres comandos siguientes usando OpenSSL para generar los archivos .pem.
$ openssl pkcs12 -in mycert.p12 -cacerts -nokeys -out cacert.pem
$ openssl pkcs12 -in mycert.p12 -clcerts -nokeys -out mycert.pem
$ openssl pkcs12 -in mycert.p12 -nocerts -nodes -out mykey.pem
La documentación establece elEl archivo cacert.pem puede ser referenciado directamente por una aplicación usando el archivo mismo, lo que creo que he hecho dentro de mi script PHP, sin embargo, no está claro dónde debo poner el otromycert & mykey pem files.
La documentación establece lo siguiente con respecto a esto: -
La forma en que una aplicación pasa el certificado SSL del cliente emitido cuando establece una conexión de red SSL depende de la aplicación y del entorno, pero esencialmente necesitaría acceder al archivo "mycert.pem" y "mykey.pem", o en algunos casos, a un solo archivo combinado que contiene cert y key.
Entonces, en ninguna parte dice cómo la aplicación utiliza estos dos archivos, por el momento los acabo de dejar en el mismo directorio que el archivo cacert.pem.
Si trato de acceder a la urlhttps://api.royalmail.com/shipping/onboarding directamente desde el navegador, me pide que seleccione un certificado, lo selecciono y luego ingreso la contraseña correcta cuando me pide 'Conceder o denegar permiso para usar esta clave'. Una vez que ingrese la contraseña correcta, aparece la siguiente página: ¿alguien puede confirmar si esto significaría que el problema está a mi final o algo que Royal Mail no ha configurado correctamente al final?
Además de esto, el script PHP real que tengo que se utiliza para enviar solicitudes SOAP a la API de envío no está funcionando (probablemente relacionado con todo lo anterior).
Dentro de mi script PHP, las opciones de soapclient se configuran de la siguiente manera:
$soapclient_options['cache_wsdl'] = 'WSDL_CACHE_NONE';
$soapclient_options['local_cert'] = 'certs/cacert.pem';
$soapclient_options['passphrase'] = $api_certificate_passphrase;
$soapclient_options['trace'] = true;
$soapclient_options['ssl_method'] = 'SOAP_SSL_METHOD_SSLv3';
$soapclient_options['location'] = 'https://api.royalmail.com/shipping/onboarding';
$client = new SoapClient('SAPI/ShippingAPI_V2_0_8.wsdl', $soapclient_options);
$client->__setLocation($soapclient_options['location']);
Cuando ejecuto el script PHP (este es básicamente el mismo código que Royal Mail se proporciona con mis propios datos personales de inicio de sesión de API) recibo el siguiente mensaje en el navegador:
Could not connect to host
REQUEST: [email protected] rngfJ+4dt4Gt855a5pr6u38i3B4= ODcwMTE5Nzc3 2015-10-13T11:02:20Z 2015-10-13T11:02:201.00526348001DeliveryDSD12015-10-13bobSS23, Some AvenueLondonE10g1000000
Obviamente, esto no puede conectarse al host por alguna razón desconocida, esta última es simplemente la solicitud que se envió. El resto del script PHP es exactamente el mismo que el script de Royal Mail que me enviaron y han confirmado que es utilizado por otros y funciona bien.
Estoy trabajando en un entorno WAMP aunque el código eventual estará en un entorno Linux.Alguien puede ayudar Realmente estoy desconcertado y Royal Mail no ha podido proporcionar ningún soporte técnico sólido todavía.
ACTUALIZAREste es el mensaje de error completo que se muestra en el navegador (he cambiado la dirección de correo electrónico por motivos de seguridad)
Invalid Request REQUEST: [email protected] dgCW98Vqw3ladYgPPpNialODhvI= MTMzMjE1NjM4 2015-10-13T13:25:30Z 2015-10-13T13:25:302.00526348001DeliveryDSD12015-10-13Jon DoeSS23, Some RoadLondonE10g1000000
Fusioné los dos archivos pem en un solo archivo llamado 'bundle.pem' y hice referencia a esto en la variable 'local_cert' para SoapClient & BINGO que ahora se está conectando. Esto ahora ya muestra elNo pudo conectar pero establece una 'Solicitud no válida' en su lugar, así que al menos ahora esto se está conectando y me está dando un error diferente.
Mi script PHP completo está abajo:
<?php
ini_set('default_socket_timeout', 120);
ini_set('soap.wsdl_cache_enabled',1);
ini_set('soap.wsdl_cache_ttl',1);
$api_password = "xxxxxxxxxxxxxx!";
$api_username = "[email protected]";
$api_application_id = "xxxxxxxxxxxx";
$api_service_type = "D";
$api_service_code = "SD1";
$api_service_format = "";
$api_certificate_passphrase = 'xxxxxxxxxx';
$api_service_enhancements = "";
$data = new ArrayObject();
$data->order_tracking_id = "";
$data->shipping_name = "Jon Doe";
$data->shipping_company = "SS";
$data->shipping_address1 = "23, Some Road";
$data->shipping_address2 = "";
$data->shipping_town = "London";
$data->shipping_postcode = "E1";
$data->order_tracking_boxes = "0";
$data->order_tracking_weight = "1000";
$time = gmdate('Y-m-d\TH:i:s');
$created = gmdate('Y-m-d\TH:i:s\Z');
$nonce = mt_rand();
$nonce_date_pwd = pack("A*",$nonce) . pack("A*",$created) . pack("H*", sha1($api_password));
$passwordDigest = base64_encode(pack('H*',sha1($nonce_date_pwd)));
$ENCODEDNONCE = base64_encode($nonce);
$soapclient_options = array();
$soapclient_options['cache_wsdl'] = 'WSDL_CACHE_NONE';
$soapclient_options['local_cert'] = 'royalmail/cert/bundle.pem';
$soapclient_options['passphrase'] = $api_certificate_passphrase;
$soapclient_options['trace'] = true;
$soapclient_options['ssl_method'] = 'SOAP_SSL_METHOD_SSLv3';
$soapclient_options['exceptions'] = true;
$soapclient_options['location'] = 'https://api.royalmail.com/shipping/onboarding';
//launch soap client
$client = new SoapClient('royalmail/ShippingAPI_V2_0_8.wsdl', $soapclient_options);
$client->__setLocation($soapclient_options['location']);
//headers needed for royal mail
$HeaderObjectXML = '<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-000">
<wsse:Username>'.$api_username.'</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">'.$passwordDigest.'</wsse:Password>
<wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">'.$ENCODEDNONCE.'</wsse:Nonce>
<wsu:Created>'.$created.'</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>';
//push the header into soap
$HeaderObject = new SoapVar( $HeaderObjectXML, XSD_ANYXML );
//push soap header
$header = new SoapHeader( 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd', 'Security', $HeaderObject );
$client->__setSoapHeaders($header);
//build the request
$request = array(
'integrationHeader' => array(
'dateTime' => $time,
'version' => '1.0',
'identification' => array(
'applicationId' => $api_application_id,
'transactionId' => $data->order_tracking_id
)
),
'requestedShipment' => array(
'shipmentType' => array('code' => 'Delivery'),
'serviceOccurence' => '1',
'serviceType' => array('code' => $api_service_type),
'serviceOffering' => array('serviceOfferingCode' => array('code' => $api_service_code)),
'serviceFormat' => array('serviceFormatCode' => array('code' => $api_service_format)),
'shippingDate' => date('Y-m-d'),
'recipientContact' => array('name' => $data->shipping_name, 'complementaryName' => $data->shipping_company),
'recipientAddress' => array('addressLine1' => $data->shipping_address1, 'addressLine2' => $data->shipping_address2, 'postTown' => $data->shipping_town, 'postcode' => $data->shipping_postcode),
'items' => array('item' => array(
'numberOfItems' => $data->order_tracking_boxes,
'weight' => array( 'unitOfMeasure' => array('unitOfMeasureCode' => array('code' => 'g')), 'value' => ($data->order_tracking_weight*1000) //weight of each individual item
)
)
)
)
);
//if any enhancements, add it into the array
if($api_service_enhancements != "") {
$request['requestedShipment']['serviceEnhancements'] = array('enhancementType' => array('serviceEnhancementCode' => array('code' => $api_service_enhancements)));
}
//try make the call
try {
$response = $client->__soapCall( 'createShipment', array($request), array('soapaction' => 'https://api.royalmail.com/shipping/onboarding') );
} catch (Exception $e) {
//catch the error message and echo the last request for debug
echo $e->getMessage();
echo " REQUEST:\n" . $client->__getLastRequest() . "\n";
die;
}
//check for any errors
if(isset($response->integrationFooter->errors)) {
$build = "";
//check it wasn't a single error message
if(isset($response->integrationFooter->errors->error->errorCode)) {
$build .= $output_error->errorCode.": ".$output_error->errorDescription."<br/>";
} else {
//loop out each error message, throw exception will be added ehre
foreach($response->integrationFooter->errors->error as $output_error) {
$build .= $output_error->errorCode.": ".$output_error->errorDescription."<br/>";
}
}
echo $build; die;
}
print_r($response);
echo "REQUEST:\n" . $client->__getLastRequest() . "\n";
die;
?>
Solo para mayor claridad, agregué un volcado de la variable $ request justo antes de que llegue al bloque try / catch (tenga en cuenta que esto es un poco largo).
Array
(
[integrationHeader] => Array
(
[dateTime] => 2015-10-13T13:34:44
[version] => 1.0
[identification] => Array
(
[applicationId] => 0526348001
[transactionId] =>
)
)
[requestedShipment] => Array
(
[shipmentType] => Array
(
[code] => Delivery
)
[serviceOccurence] => 1
[serviceType] => Array
(
[code] => D
)
[serviceOffering] => Array
(
[serviceOfferingCode] => Array
(
[code] => SD1
)
)
[serviceFormat] => Array
(
[serviceFormatCode] => Array
(
[code] =>
)
)
[shippingDate] => 2015-10-13
[recipientContact] => Array
(
[name] => Jon Doe
[complementaryName] => SS
)
[recipientAddress] => Array
(
[addressLine1] => 23, Some Road
[addressLine2] =>
[postTown] => London
[postcode] => E1
)
[items] => Array
(
[item] => Array
(
[numberOfItems] => 0
[weight] => Array
(
[unitOfMeasure] => Array
(
[unitOfMeasureCode] => Array
(
[code] => g
)
)
[value] => 1000000
)
)
)
)
)