Apéndice A del sistema de actualización de la suscripción: Actualizaciones dinámicas

Introducción

Esta guía se publica como un anexo a la Sistema de actualización de suscripción documentación y analiza la funcionalidad de actualización dinámica. Está destinado a desarrolladores, técnicos y otras personas con habilidades de codificación avanzadas.

Esta guía debe utilizarse junto con la Guía del usuario del sistema de actualización por suscripción. Se harán referencias a la Guía del usuario cuando sea apropiado.

RESUMEN

Actualizaciones dinámicas, también denominadas actualizaciones de paso, permite a los comerciantes actualizar una suscripción de consumidor a una nueva suscripción sin configurar previamente una opción en el sistema. La actualización se puede realizar en la misma subcuenta o en una subcuenta diferente, y puede codificarse en una página o crearse dinámicamente mediante un script. Las actualizaciones dinámicas las configura en su totalidad el comerciante, pero utilizan el sistema de formularios de CCBill. Para utilizar las actualizaciones dinámicas, el comerciante debe ponerse en contacto con el servicio de atención al comerciante y solicitar que se habilite la función.

Soporte de precios regionales

Las actualizaciones dinámicas admiten el uso de Precios regionales. De forma predeterminada, se utilizará la configuración de precios regionales de la cuenta a la que se actualiza la suscripción. Opcionalmente, se puede aplicar un perfil de precios regionales que no sea el predeterminado para la cuenta actualizada, como se explica a continuación. Esta configuración se ignorará si los precios regionales no están habilitados en la cuenta. Para obtener más información sobre precios regionales, consulte el Guía del usuario de precios regionales.
El sistema admite tanto Tarjeta De Crédito y ACH (Cámara de compensación automatizada) actualizaciones.

Implementación

Las actualizaciones dinámicas se crean pasando variables a una cadena de consulta. Las solicitudes deben enviarse al siguiente script CGI con valores de variable adjuntos:

https://bill.ccbill.com/jpost/upgradeSubscription.cgi

Las actualizaciones dinámicas se completarán como si estuvieran configuradas previamente en el sistema. Una vez que las variables se hayan pasado al script CGI anterior, el consumidor será redirigido al formulario de actualización.

Para crear la actualización, simplemente cree un punto de precio en el Área de precios del Portal de administración de CCBill. Para obtener ayuda para crear puntos de precio, visite el Puntos de precio página de ayuda.

Como se explica en la Guía del usuario de actualización de suscripción, hay dos métodos de actualización disponibles: cifrado y Publicación HTTPS en segundo plano. Los valores necesarios para las actualizaciones dinámicas deben incluirse junto con las variables enumeradas en la Guía del usuario para el método deseado. Tenga en cuenta que el upgradeTypeId La variable se incluye en ambas guías, pero se obtiene de una manera diferente a las actualizaciones regulares (no dinámicas).

Los siguientes valores de variable deben pasarse a la cadena:

Variable
Nombre
DescripciónValor de ejemplo
upgradeTypeIdEl identificador único del precio al que se actualizará la suscripción. Este valor se puede obtener en la sección de administración de precios del portal de administración de CCBill.4530
oferta especialIndica si la actualización es una oferta especial. Un valor de cero (0) significa que la actualización no es una oferta especial y cancelará la suscripción original. Un valor de uno (1) indica una oferta especial y no cancelará la suscripción original.0 ó 1
prorratearEste valor indica la opción de prorrateo preferida. Un valor de uno (1) prorratea la cantidad y un valor de dos (2) prorratea la cantidad de tiempo.1 ó 2
autenticación compartidaIndica si se utiliza la autenticación compartida; un valor de uno (1) significa que se usa autenticación compartida y un valor de cero (0) significa que no se usa autenticación compartida.0 ó 1
nombre del formularioEl nombre del formulario CCBill utilizado para realizar la actualización. Este valor es opcional; si no se especifica ningún parámetro, se utilizará el formulario de actualización predeterminado.1ug

Nota:: Si oferta especial se establece en cero (0), el prorratear debe incluirse el parámetro. De lo contrario, el prorratear no se utiliza el parámetro.

Si desea especificar una configuración de precios regionales en particular, opcionalmente puede pasar la siguiente variable:

Variable
Nombre
DescripciónValor de ejemplo
regionalPricingIdEl identificador único para la configuración de precios regionales que desea utilizar para la cuenta actualizada. Este valor se ignorará si los precios regionales no están habilitados en la cuenta.443

El valor para regionalPricingId se puede obtener poniéndose en contacto con el Soporte para comerciantes.

Ejemplos de código

Tal y como se menciona en el reciente Guía del usuario del sistema de actualización por suscripción, hay dos métodos disponibles para transmitir solicitudes de actualización: Cifrado y Publicación HTTPS de backend (consulte la Guía del usuario para obtener detalles sobre estos dos métodos). Para cada tipo, los parámetros se pueden pasar a través de la URL o mediante el uso de campos de formulario HTML ocultos. Algunos parámetros son opcionales, como se indica en la Guía del usuario. Cada uno de los siguientes ejemplos de código muestra parámetros opcionales como texto en negrita.

Método de cifrado

Si utiliza el método de cifrado, pase las variables anteriores en la cadena de solicitud de actualización además de las especificadas en la Guía del usuario. La siguiente URL muestra un ejemplo de una solicitud de actualización dinámica:

https://bill.ccbill.com/jpost/upgradeSubscription.cgi?clientAccnum=900000&clientSubacc=0000&enc=jas2jasdfbJBD19823naISDHASDoiksj923&subscriptionId=0208224109000000496<strong>&upgradeClientSubacc=0001&upgradeClientAccnum=900000&upgradeTypeId=4530&regionalPricingId=443</strong>

Alternativamente, la solicitud se puede realizar utilizando campos de formulario HTML ocultos, como se muestra en el siguiente ejemplo:

<form method="POST"<br>action="https://bill.ccbill.com/jpost/upgradeSubscription.cgi"><br><input type="hidden" name="clientAccnum" value="900000"><br><input type="hidden" name="clientSubacc" value="0000"><br><input type="hidden" name="enc" value=" jas2jasdfbJBDA9823naISDHdSDoiksj923"><br><input type="hidden" name="subscriptionId" value="1234567890"><br><input type="submit" name="submit" value="UpgradeSubscription"><br><strong><input type="hidden" name="upgradeClientAccnum" value="900000"><br><input type="hidden" name="upgradeClientSubacc" value="0001"><br><input type="hidden" name="upgradeTypeId" value="40530"><br><input type="hidden" name="regionalPricingId" value="443"></strong><br></form>

Método de publicación HTTPS en segundo plano

Si usa el Publicación HTTPS en segundo plano método, las variables de actualización dinámica deben pasarse durante el paso dos.

El siguiente ejemplo de código demuestra el paso uno de la publicación HTTPS de backend usando actualizaciones dinámicas:

https://bill.ccbill.com/jpost/upgradeSubscription.cgi?clientAccnum=900000&clientSubacc=0000&action=allowUpgrade&subscriptionId=0208724102000000496

Los valores también se pueden pasar mediante un formulario HTML

<form method="POST" 
action="https://bill.ccbill.com/jpost/upgradeSubscription.cgi">
<input type="hidden" name="clientAccnum" value="900000">
<input type="hidden" name="clientSubacc" value="0000">
<input type="hidden" name="action" value=" allowUpgrade">
</form>

La cadena devolverá un valor numérico. Un valor de "1" significa que la solicitud está aprobada (consulte la Guía del usuario para obtener una lista completa de los valores devueltos). El siguiente ejemplo representa el código que se puede utilizar para el paso dos del proceso:

https://bill.ccbill.com/jpost/upgradeSubscription.cgi?clientAccnum=900000&clientSubacc=0000&action=upgradeSubscription&subscriptionId=0208224109000000496& upgradeClientSubacc = 0001 & upgradeClientAccnum = 900000 & upgradeTypeId = 40530®ionalPricingId = 443

Los valores también se pueden pasar mediante un formulario HTML:

<form method="POST"
action="https://bill.ccbill.com/jpost/upgradeSubscription.cgi">
<input type="hidden" name="clientAccnum" value="900000">
<input type="hidden" name="clientSubacc" value="0000">
<input type="hidden" name="action" value=" upgradeSubscription">
<input type="hidden" name="subscriptionId" value="1234567890">
<input type="submit" name="submit" value="Upgrade Subscription">
<strong><input type="hidden" name="upgradeClientAccnum" value="900000">
<input type="hidden" name="upgradeClientSubacc" value="0001">
<input type="hidden" name="upgradeTypeId" value="40530">
<input type="hidden" name="regionalPricingId" value="443"></strong>
</form>

Los ejemplos de formularios HTML muestran un botón que, cuando se hace clic, pasará los parámetros al sistema de actualización de suscripción. Si tiene éxito, se realizará la actualización.

Postback

Los valores de las variables se contabilizan mediante el sistema de Contabilización de antecedentes de CCBill. Los siguientes valores se enviarán a la URL de aprobación o la URL de denegación cuando se haya realizado o denegado la actualización, respectivamente:

  • originalClientAccnum. El número de cuenta de comerciante de seis dígitos desde donde se originó la actualización.
  • originalClientSubacc. El número de subcuenta del comerciante de cuatro dígitos desde donde se originó la actualización.
  • originalSubscriptionId. El número de identificación de suscripción de la suscripción original.

Para obtener más información sobre el uso de la publicación de antecedentes, consulte CCBill Guía del usuario de la publicación en segundo plano.