[SOLUCIONADO] No encuentro tutorial de la API de ClickBank

[rbczgz]

Hola amig@s,

Llevo un tiempo bastante considerable buscando algún tutorial o manual de especificaciones de la API de ClickBank, en español y donde se explique de manera muy accesible cómo usar esta API.

Si alguien conoce algún tutorial o manual para esto, le agradecería me pasase el enlace para poderlo estudiar.

Muchas gracias.

[mortiprogramador]

Saludo
Uhm, pues acá esta en inglés, pero en español no se ve el asunto,
sin embargo preguntar por acá a ver que dicen.
.

[rbczgz]

Hola mortiprogramador,

Muchas gracias por tu respuesta, lo de español lo decía porque si ya me resulta difícil entenderlo en este idioma, ni te cuento en inglés que no lo entiendo ni medio bien...

He llamado al teléfono que aparece en el enlace que me has pasado pero, lógicamente, no están en sábado.

El enlace que me has pasado con la documentación en inglés lo había revisado ya, pero ahí no me aclaran lo que necesito, que, básicamente es saber cómo consultar si una venta se ha devuelto y saber cómo consultar si las ventas recurrentes se han pagado, están pendientes o se han cancelado.

Tengo un código que me devuelve unas respuestas pero no tengo claro cómo debo procesarlas para obtener lo que necesito, te lo copio por si me puedes dar alguna idea (si puede ser con ejemplos, mejor )

Ahí va:

Código PHP:

<?php
 
//Activamos la visualización de todo tipo de errores y notificaciones
error_reporting(E_ALL);
ini_set("display_errors", 1);
 
 
//Esto lo saqué de algún sitio de Internet que ahora no recuerdo,
//funciona, pero no sé cómo procesar la información que recibo.
define('CLICKBANK_DEV_KEY','DEV-LO-QUE-SEA');
define('CLICKBANK_API_KEY','API-LO-QUE-SEA');
 
 
 
Class ClickBank
{
    /*
     * $tries   how many times to check for receipt
     *          because when you come back from clicbank it sometimes shows it invalid
     *          
     * $receipt 
     * 
     * @return  empty array if receipt not valid
     *          receipt info array if receipt is valid 
     */
    function get_payment_info($tries, $receipt){
        $receipt_info = array();
        while($tries>0 && count($receipt_info)==0){
            $receipt_info = $this->get_receipt_info($receipt);
            $tries--;   
        }
        return $receipt_info;
    }
 
    function get_receipt_info($receipt){
        $receipt_info = array();
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, "https://api.clickbank.com/rest/1.3/orders/$receipt");
        curl_setopt($ch, CURLOPT_HEADER, false); 
        //curl_setopt($ch, CURLOPT_GET, true);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json", "Authorization:".CLICKBANK_DEV_KEY.":".CLICKBANK_API_KEY));
        $result = curl_exec($ch);
        $curl_info = curl_getinfo($ch);
        curl_close($ch);
 
        if($curl_info['http_code']==200){
            $receipt_info = json_decode($result);           
        }
 
        return $receipt_info;
    }
}
/*Modo de empleo
 
$clickbank = new ClickBank();
 
$receipt = $_GET['cbreceipt']; o $receipt = $_POST['cbreceipt'];
 
// Esto devuelve los detalles de la transacción
$transaction_info = $clickbank->get_payment_info(10, $receipt);
*/
 
 
?>
 

Y en esas estamos... Si me puedes echar un cable, te lo agradecería...

[mortiprogramador]

Saludo rbczgz

Pues encontré este link que es un componente para usar la api.
Por otra parte, estuve intentando crear las keys para
hacer uso de la api, pero te envié un mensaje privado
preguntandote algunas cosas al respecto.

En cuanto al código publicado, lo que hace es apuntar a la api,
y espera la info correspondiente para cada mètodo

Por ej, tenemos el método /1.3/orders/list
que espera los siguientes parámetros:

Archivo Adjunto 763

Y responde una lista de OrderDatas

En cuanto al consumo, lamentablemente el acceso está restringido,
así que revisa el mensaje que te envié para validar esas preguntas.

[rbczgz]

Hola mortiprogramador,

Muchas gracias por las molestias que te estás tomando solo para ayudarme. Ya te he respondido el mensaje privado.

He revisado los enlaces que me has pasado por aquí y el del componente no entiendo nada, el de la lista de OrderDatas me aparece la página en blanco.

Yo sigo investigando mientras espero tus noticias, a ver si consigo aclarar este asunto.

[mortiprogramador]

Saludo
Pues en cuanto a lo de OrderDatas, debería aparecer una definición
del schema de respuesta.

Código XML:

<xs:schema version="1.0"><xs:element name="orderData" type="orderData"/><xs:complexType name="orderData"><xs:sequence><xs:element name="date" type="xs:dateTime" nillable="true" minOccurs="0"/><xs:element name="receipt" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="promo" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="pmtType" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="txnType" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="item" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="amount" type="xs:decimal" nillable="true" minOccurs="0"/><xs:element name="site" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="affi" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="country" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="state" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="lastName" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="firstName" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="currency" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="email" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="zip" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="customerContactInfo" type="contactField" nillable="true" minOccurs="0" maxOccurs="unbounded"/><xs:element name="refundsBlocked" type="xs:boolean" minOccurs="0"/><xs:element name="rebillAmount" type="xs:decimal" nillable="true" minOccurs="0"/><xs:element name="processedPayments" type="xs:int" nillable="true" minOccurs="0"/><xs:element name="futurePayments" type="xs:int" nillable="true" minOccurs="0"/><xs:element name="nextPaymentDate" type="xs:dateTime" nillable="true" minOccurs="0"/><xs:element name="status" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="accountAmount" type="xs:decimal" nillable="true" minOccurs="0"/><xs:element name="role" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="customerDisplayName" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="title" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="recurring" type="xs:boolean" minOccurs="0"/><xs:element name="physical" type="xs:boolean" minOccurs="0"/><xs:element name="customerRefundableState" type="refundableState" nillable="true" minOccurs="0"/></xs:sequence></xs:complexType><xs:complexType name="contactField"><xs:sequence><xs:element name="field" type="xs:string" nillable="true" minOccurs="0"/><xs:element name="value" type="xs:string" nillable="true" minOccurs="0"/></xs:sequence></xs:complexType><xs:simpleType name="refundableState"><xs:restriction base="xs:string"><xs:enumeration value="REFUNDABLE"/><xs:enumeration value="SUGGESTED_REFUND_BLOCK"/><xs:enumeration value="UNREFUNDABLE"/><xs:enumeration value="ALREADY_REFUNDED"/><xs:enumeration value="TO_OLD"/><xs:enumeration value="REFUND_BLOCKED"/><xs:enumeration value="HAS_OPEN_REFUND"/></xs:restriction></xs:simpleType></xs:schema>
 

Por otra parte, encontre este link en donde está la api para
varios idiomas, pero al intentar ingresar a otras distintas a inglés,
dice que no hay acceso y que hay que hablar con un dueño de cuenta de Zendesk.

En cuanto a las keys, ya las pude generar, pero el código que publicaste
al menos en mi caso no me devuelve nada, tu dices que a tí sí te responde algo,
podrías contarnos cual es el dato que envías en la variable cbrecepit
y la respuesta que retorna?
Ahí vamos poco a poco revisando eso.

[rbczgz]

Hola mortiprogramador,

Lo que mencionas de la definición del schema de respuesta, la verdad es que no lo entiendo, no tengo ni idea de xml

El enlace que mencionas para varios idiomas, a mi sí me funciona en español y se puede ver este enlace entre otros de otros idiomas.

En cuanto a la variable cbreceipt, ahí tenemos un problema, porque eso es el código de un recibo de ClickBank, pero tiene que ser uno válido y debe pertenecer a la misma cuenta que utiliza la API, ya que si no, obviamente, no se puede acceder a la info del recibo

La respuesta que retorna no la debo publicar aquí porque es información que, entre otras cosas, contiene los datos del comprador, por lo que moral y legalmente, no tengo permitido publicarlo...

Creo que podría publicarlo de esta forma, con casi todos los datos "comprometidos" cambiados:

Esto es lo que me genera la respuesta que copio a continuación:

Código PHP:

<?php
$clickbank = new ClickBank();
 
$receipt = "SR46E7JH";
echo "Información de transacción:<br>";
$transaction_info = $clickbank->get_payment_info(10, $receipt);
echo "<pre>";
print_r($transaction_info);
echo "</pre>";
?>
 

Código:

stdClass Object
(
    [orderData] => Array
        (
            [0] => stdClass Object
                (
                    [date] => 2015-07-08T15:14:10-07:00
                    [receipt] => SR46E7JH
                    [promo] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [pmtType] => PYPL
                    [txnType] => SALE
                    [item] => X (Si el vendedor tiene más de un producto, este es el Id del mismo)
                    [amount] => 352.00
                    [site] => USUARIO del vendedor (creo)
                    [affi] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [country] => XX
                    [state] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [lastName] => APELLIDO del comprador
                    [firstName] => NOMBRE del comprador
                    [currency] => MONeda en la que ha pagado el comprador
                    [email] => [email protected]
                    [zip] => Codigo_postal_del_comprador
                    [rebillAmount] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [processedPayments] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [futurePayments] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [nextPaymentDate] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [status] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [accountAmount] => 236.36 (Cantidad que le queda a la cuenta que hace la consulta)
                    [role] => VENDOR
                    [customerDisplayName] => Nombre para mostrar como lo tiene configurado el cliente
                    [title] => Nombre del producto según aparece en ClickBank
                    [recurring] => false
                    [physical] => false
                    [customerRefundableState] => TO_OLD
                )

            [1] => stdClass Object
                (
                    [date] => 2015-08-12T21:45:32-07:00
                    [receipt] => SR46E7JH
                    [promo] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [pmtType] => PYPL
                    [txnType] => RFND
                    [item] => 2
                    [amount] => -352.00
                    [site] => USUARIO del vendedor (creo)
                    [affi] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [country] => XX
                    [state] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [lastName] => APELLIDO del comprador
                    [firstName] => NOMBRE del comprador
                    [currency] => MONeda en la que ha pagado el comprador
                    [email] => [email protected]
                    [zip] => Codigo_postal_del_comprador
                    [rebillAmount] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [processedPayments] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [futurePayments] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [nextPaymentDate] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [status] => stdClass Object
                        (
                            [@nil] => true
                        )

                    [accountAmount] => -236.36
                    [role] => VENDOR
                    [customerDisplayName] => Nombre para mostrar como lo tiene configurado el cliente
                    [title] => Nombre del producto según aparece en ClickBank
                    [recurring] => false
                    [physical] => false
                    [customerRefundableState] => stdClass Object
                        (
                            [@nil] => true
                        )

                )

        )

)

Esto corresponde a una venta devuelta, tengo acceso a ver ventas normales, devueltas pero no recurrentes...

Espero que sirva...

[mortiprogramador]

Saludo

Pues en cuanto al schema de respuesta, piensalo como un objeto de php.

El enlace a mí me sigue respondiendo con

You do not have access to this topic
You do not have access to this page.
Please contact the account owner of this Zendesk for further help.

Tal vez es porque la cuenta mía es nueva, y aún no tiene configurado eso.

Y finalmente, con la respuesta que te da, ¡ya está!
Es un objeto, en cuyo caso ya puedes mostrar la info con php

Ej

Código PHP:

foreach($transaction_info->orderData as $id=>$value)
{
    if( $value->pmtType == 'PYPL' )
        $value->pmtType = 'Paypal';
    if( $value->txnType == 'SALE')
        $value->txnType = 'venta';    
    if( $value->txnType == 'RFND')
        $value->txnType = 'refrendación';
        
    echo utf8_decode('</br>El ciente '.$value->firstName.' '.$value->lastName.' ha realizado una '.$value->txnType.' por '.$value->pmtType.' por valor de '.$value->amount);
}
 

Sí te fijas, el objeto devuelto tiene los mismos datos del schema.
¿En cuanto a las ventas recurrentes, te refieres a las mismas compras
que hace un mismo usuario?
Esa consulta tendría que hacerse con el list que veiamos ayer creo yo,
¿O a que te refieres con las recurrentes?

Bue, mientras, revisa lo que te pasé, debe funcionar sin problema.

[rbczgz]

Iniciado por mortiprogramador

Pues en cuanto al schema de respuesta, piensalo como un objeto de php.

Ahí tengo el primer problema, aún no he conseguido un curso, tutorial o lo que sea en el que aprender correctamente y desde lo más básico POO

Iniciado por mortiprogramador

El enlace a mí me sigue respondiendo con

You do not have access to this topic
You do not have access to this page.
Please contact the account owner of this Zendesk for further help.

Tal vez es porque la cuenta mía es nueva, y aún no tiene configurado eso.

Sí, lo más probable es que sea eso...

Iniciado por mortiprogramador

Y finalmente, con la respuesta que te da, ¡ya está!
Es un objeto, en cuyo caso ya puedes mostrar la info con php

Ej

Código PHP:

foreach($transaction_info->orderData as $id=>$value)
{
    if( $value->pmtType == 'PYPL' )
        $value->pmtType = 'Paypal';
    if( $value->txnType == 'SALE')
        $value->txnType = 'venta';    
    if( $value->txnType == 'RFND')
        $value->txnType = 'refrendación';
        
    echo utf8_decode('</br>El ciente '.$value->firstName.' '.$value->lastName.' ha realizado una '.$value->txnType.' por '.$value->pmtType.' por valor de '.$value->amount);
}
 

Sí te fijas, el objeto devuelto tiene los mismos datos del schema.

Sí, es cierto, son los mismos datos, pero como te decía, aún es un tema pendiente el aprender POO... Tendré que seguir intentando, básicamente lo que tengo que hacer es comprobar si un "receipt" está o no devuelto, en el caso de las ventas "normales" y en el caso de las recurrentes, si está pagado en tiempo, está pendiente o está cancelado, con el ejemplo que me has puesto, creo que podré hacer algo de las "normales", el tema será con las recurrentes...

Iniciado por mortiprogramador

¿En cuanto a las ventas recurrentes, te refieres a las mismas compras
que hace un mismo usuario?
Esa consulta tendría que hacerse con el list que veiamos ayer creo yo,
¿O a que te refieres con las recurrentes?

Las ventas recurrentes ("recurring" creo que las llaman ellos) son las que se hacen periódicamente (mensual, trimestral, anual, etc...) tipo cursos por entregas, membresías, etc... En estas, como decía, necesito comprobar si están al día en los pagos y si no están canceladas.

Iniciado por mortiprogramador

Bue, mientras, revisa lo que te pasé, debe funcionar sin problema.

Sí, con eso tengo para "entretenerme" un rato largo, jejeje, solo entenderlo, ya me llevará un buen rato, pero lo conseguiré (o si no, te volveré a pedir ayuda al respecto )

Pero todo esto será ya mañana, hoy se ha hecho tarde y la cabeza ya no me da más. Muchas gracias por todas las molestias que te estás tomando para ayudarme, de verdad, igual soy pesado, pero no te puedes imaginar lo agradecido que estoy.

[mortiprogramador]

Saludo
Pues sí, con eso tendrás para divertirte.
En cuanto a POO, te dejo este link que es una serie de entregas
sobre el tema, y está explicado con ejemplos claros, espero te sirva.

[rbczgz]

Hola mortiprogramador,

Muchas gracias por el enlace, voy a revisarlo con detenimiento a ver si consigo aprender algo a fondo. Te voy contando

[rbczgz]

Hola de nuevo,

Después de analizar ese enlace, tus ayudas y muchas más cosas que he seguido buscando, encontré este código que adapté a una función para poderlo llamar cuando sea necesario (lo que no anoté de dónde lo saqué, por eso no puedo poner los créditos, si alguien lo sabe, que me lo diga y los añado):

Código PHP:

<?php
function comprobarPedido($receipt) {
 
 
    define('CB_DEVELOPER_KEY',  'DEV-');    // Tu Clave de DESARROLLADOR.
    define('CB_CLERK_KEY',      'API-');    // Tu Clave de ASISTENTE.
 
 
    define('VENDOR_ID', '');        // Dejalo vacío si quieres aceptar cualquier vendedor de CB
    define('ERROR_ON_REFUND', 1);   // Muestra error si la compra fué reembolsada (1 or 0).
    define('ERROR_ON_CANCEL', 1);   // Muestra error si una suscripción fue cancelada (1 or 0).
 
 
 
    // DEFINICIONES DE ERROR
    define('ERROR_MSG_EMPTY_RECEIPT',           "No has ingresado ningún dato");
    define('ERROR_MSG_INVALID_RECEIPT',         "El nº de compra es inválido");
    define('ERROR_MSG_COULD_NOT_CONNECT',       "Oops! El Sistema no puede conectarse con el servidor de ClickBank. Por favor intenta mas tarde!");
    define('ERROR_MSG_BAD_RECEIPT',             "No se puede encontrar esa compra");
    define('ERROR_MSG_PARSE_ERROR',             "Sin resultados...");
    define('ERROR_MSG_NO_ORDERDATA',            "La propiedad 'orderData' no existe.");
    define('ERROR_MSG_INAPPROPRIATE_VENDOR',    "Nosotros no vendemos procuctos de este vendedor.");
    define('ERROR_MSG_REFUNDED',                "Tu compra fue reembolsada.");
    define('ERROR_MSG_CANCELED',                "Tu suscripción ha sido cancelada");
 
    if (substr($receipt, 0, 1) == '#') {
        $receipt = trim(substr($receipt, 1));
    }
    if (preg_match('|^([0-9A-Z]*)[-]|', $receipt, $matches)) {
        $receipt = $matches[1];
    }
    // CHEQUEA LOS VENDEDORES ACEPTADOS.
    $acceptable_vendors = array();
    $arr = explode(',', VENDOR_ID);
    foreach($arr as $vendor_id) {
        $vendor_id = trim($vendor_id);
        if (preg_match('|^[0-9A-Z]{5,10}$|i', $vendor_id)) {
            $acceptable_vendors[] = strtoupper($vendor_id);
        }
    }
 
    $err = false;
 
    // Chequea el formato de los códigos de pedido
    if (!$err && $receipt == '') {
        $err = ERROR_MSG_EMPTY_RECEIPT;
    }
    if (!$err && !preg_match('|^[0-9A-Z]{8,9}$|', $receipt)) {
        $err = ERROR_MSG_INVALID_RECEIPT;
    }
 
    if (!$err) {
        $ch = curl_init();
 
        // CONECTA A LA API DE CB
        curl_setopt($ch, CURLOPT_URL, 'https://api.clickbank.com/rest/1.3/orders/' . $receipt);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
            'Accept: application/json',
            'Authorization: ' . CB_DEVELOPER_KEY . ':' . CB_CLERK_KEY
        ));
        $result = curl_exec($ch);
        if ($result === FALSE) { // NO PUEDE CONECTAR.
            $err = ERROR_MSG_COULD_NOT_CONNECT;
        } else {
            $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
            if ($code != 200) {
                $err = ERROR_MSG_BAD_RECEIPT;
            }
        }
        curl_close($ch);
 
        
    @   $o = json_decode($result);
        if (!$err && !is_object($o)) {
            $err = ERROR_MSG_PARSE_ERROR;
        }
        if (!$err && !property_exists($o, 'orderData')) {
            $err = ERROR_MSG_NO_ORDERDATA;
        }
 
        // CHEQUEA LOS DATOS DE LA ORDEN
        if (!$err) {
            $data = is_array($o->orderData) ? $o->orderData : array($o->orderData);
 
            $refunded = false;
            foreach($data as $record) {
                if ($record->txnType == 'RFND') {
                    $refunded = true;
                }
            }
 
            $canceled = (is_string($data[0]->status) && $data[0]->status == 'CANCELED');
 
            $site = strtoupper($data[0]->site);
            $site_is_ok = sizeof($acceptable_vendors) == 0 ? true : in_array($site, $acceptable_vendors);
 
            if (!$site_is_ok) {
                $err = ERROR_MSG_INAPPROPRIATE_VENDOR;
            } else if ($refunded && ERROR_ON_REFUND) {
                $err = ERROR_MSG_REFUNDED;
            } else if ($canceled && ERROR_ON_CANCEL) {
                $err = ERROR_MSG_CANCELED;
            }
        }
 
    }
 
    if ($err) {
               return $err;
                } else {
               return "Correcto";
               }
}
 
 
//Aquí el uso, como lo voy a usar con AJAX, lo he puesto así.
 
$resultado = comprobarPedido($receipt);
 
    if ($resultado != "Correcto") {
 
             echo "<h1 style=\"color: #F00;\">".$resultado."</h1><input type=\"button\" id=\"form_clickbank\" name=\"form_clickbank\" value=\"Reintentar\" onclick=\"javascript: location.reload()\">";
             } else {
 
            echo "<h1 style=\"color: #F00;\">Correcto</h1>";
           }
?>
 

Lo dejo aquí por si le sirve a alguien más y marco como solucionado el tema, para las posibles búsquedas.