API CCBill: Opciones avanzadas de afiliados

Introducción

Este documento se proporciona como un recurso técnico para los clientes de CCBill, donde se analizan las opciones avanzadas de afiliados para la API de CCBill. Este documento está dirigido a programadores, técnicos y otras personas con conocimientos avanzados de programación.

RESUMEN

La API de CCBill ofrece API de programación para usar junto con la funcionalidad en cascada de Traffic Manager. Las opciones descritas en este documento se utilizan para facilitar los eventos de transacciones cuando un proveedor de facturación no respaldado por el sistema en cascada de CCBill procesa una transacción para una venta referida por un afiliado de CCBill, para la cual CCBill realizó el pago.

Por ejemplo, si un afiliado de CCBill refiere una venta a un cliente de CCBill pero la transacción fue procesada por otro procesador a través del proceso en cascada de Traffic Manager, el afiliado aún puede recibir crédito por la venta. CCBill pagaría al afiliado aunque la transacción no se procesara a través de CCBill.

Nota:: Estas funciones no están destinadas a ser utilizadas para transacciones a través de procesadores compatibles con el sistema en cascada de CCBill. Los procesadores compatibles con el sistema en cascada normalmente manejarían los eventos descritos en este documento. Sin embargo, para situaciones en las que CCBill realizó pagos por referencias de afiliados cuando CCBill no procesó la transacción, estas API de programación se ofrecen para iniciar manualmente los eventos.

Implementación

Cada una de las opciones descritas en esta guía requiere que se pasen variables al script CGI de la API de CCBill. Se deben incluir dos conjuntos de variables en cada solicitud de cadena: los parámetros principales requeridos para todas las solicitudes de la API de CCBill y los parámetros. A continuación, se incluye una lista de variables y código de muestra.

Parámetros obligatorios (X) y opcionales (O)

 clienteAccnumnombre de usuarioContraseñaclienteSubaccusandoSubaccretornoXMLTérmica
Cuenta principalXXXOOOX
Cuenta principal con XMLXXXOOXX
Sub-cuentaXXXXOOX
Subcuenta con XMLXXXXOXX

Estos parámetros se utilizarán junto con cada acción individual a continuación. Tenga en cuenta que solo se puede realizar una acción a la vez.

Acciones

Esta sección describe cada opción de afiliado avanzada en detalle. El título de cada una de las siguientes subsecciones se utilizará como parámetro de acción como se muestra en el código de muestra.
Los valores devueltos se describen más adelante en este documento.

añadirAfiliadoPago

Esta acción permite a los clientes agregar un pago a un afiliado por una transacción referida que no será procesada por CCBill. Utilice los siguientes parámetros además de los principales parámetros de la API de CCBill anteriores.

Los programas usandoSubacc el parámetro es requerido solamente para los usuarios que se autentican con la cuenta principal. los clienteSubacc el parámetro es requerido solamente para los usuarios que se autentican en una subcuenta específica. Los dos parámetros siguientes son obligatorios independientemente del usuario

ParámetroDescripciónValor de ejemplo
identificación del afiliadoEl número de identificación de afiliado al que se aplicará la refacturación.123456
cantidadEl monto total de la venta en dólares estadounidenses.14.95

Código de muestra:

https://datalink.ccbill.com/utils/subscriptionManagement.cgi?clientAccnum=999999&clientSubacc=0000&username=user123&password=pass123&action=addAffiliatePayout&affiliateId=123456& originalSubId =1234567891&amount=14.95

agregarAfiliadoReembolso

Esta acción emite un reembolso en la transacción especificada. Utilice los siguientes parámetros además de los parámetros principales de la API de CCBill anteriores:

ParámetroDescripciónValor de ejemplo
identificación del afiliadoEl número de identificación de afiliado al que se aplicará la refacturación.123456
ID de suscripciónEl ID de suscripción para una transacción en cascada ya existente. Esta es la transacción que se reembolsará.1234567890
originalSubIdEl ID de suscripción de la transacción de facturación original. Si reembolsa la transacción original, este valor será el mismo que el de subscriptionId anterior.1234567891
transTipoEl tipo de transacción que se está devolviendo.ÚNICO, RECURRENTE o REFACTURACIÓN

Código de muestra:

https://datalink.ccbill.com/utils/subscriptionManagement.cgi?clientAccnum=999999&clientSubacc=0000&username=user123&password=pass123&action=addAffiliateRefund&affiliateId=12345

Valores de retorno

Cada una de las funciones anteriores devuelve un valor de resultado que indica éxito o fracaso. Los resultados se devolverán en formato CSV o XML, dependiendo de si se pasa o no el parámetro returnXML. Los datos CSV se devuelven de forma predeterminada; para obtener más información sobre el parámetro returnXML, consulte el Guía del usuario de la API de CCBill.

Independientemente del método de devolución, se devolverá un valor de "1" para las acciones exitosas. Cualquier otro valor devuelto indica un error. Para obtener una lista completa de códigos de error, consulte el Guía del usuario de la API de CCBill.

Ejemplo de devolución de CSV

"resultados" "1"

Ejemplo de retorno XML

1.0