API de ClickBank

Tenga en cuenta que la API de ClickBank es para que la usen quienes tienen gran experiencia en desarrollo. La API de ClickBank posibilita que una amplia gama de programas informáticos tengan acceso a la información de cuentas de ClickBank de manera segura en nombre de los propietarios de las cuentas. Entre algunas de las funciones disponibles para usuarios de la API se incluye la capacidad para realizar lo siguiente:

  • Solicitar un reembolso de la compra de un cliente
  • Solicitar una cancelación de la suscripción de un cliente
  • Recuperar una lista de transacciones de una cuenta de ClickBank por un período de tiempo determinado

Las posibilidades para los programas que usan la API son numerosas y entre ellas se incluyen las siguientes: Un panel que muestra los datos de ClickBank además de datos de cuentas que ofrecen otros servicios en línea, una herramienta para la administración de suscripciones y un paquete de informes analíticos que muestra datos sobre las tendencias de las ventas de una cuenta de ClickBank en particular. Todas estas aplicaciones y más son posibles con la nueva API de ClickBank. Además, también podrían venderse en el mercado de ClickBank. 
El servicio de API de ClickBank se basa en la arquitectura REST y proporciona un mecanismo basado en un protocolo http confiable y seguro para recuperar datos.

REST

REST es un estilo de arquitectura introducido por Roy Fielding, quien fue uno de los principales autores del protocolo HTTP en su tesis doctoral: “Architectural Styles and the Design of Network-based Software Architectures” (Estilos arquitecturales y el diseño de arquitecturas de software basadas en red). Se puede encontrar una breve introducción a REST en la reseña de Wikipedia Transferencia de Estado Representacional.

Control de versiones

La versión actual de la API de servicios de ClickBank es la siguiente: 1.3. 
La información sobre la versión es parte de la dirección URL para acceder a los servicios. Esto proporciona los beneficios que se enumeran a continuación:

  • Información clara sobre la versión de la API que se está usando
  • Una vía de actualización fácil de entender cuando se anuncian nuevas versiones de la interfaz de programación de aplicaciones (API)

Infraestructura

La API REST de ClickBank está basada en JSR-311 - El API de Java para servicios web REST. Este es un detalle de implementación de la API de servicios de ClickBank. Los mismos servicios están basados en HTTP y son de implementación agnóstica; por lo tanto, cualquier cliente web (.NET, PHP, Java, Python, Ruby, etc.) puede utilizar los servicios.

A pesar de que ClickBank no avala ninguna herramienta REST para desarrollo, sí creemos que RestClient puede resultar muy útil en el desarrollo y la prueba de servicios web RESTful.

Encabezado de solicitud

El encabezado de la API de servicios de ClickBank se compone de los parámetros de seguridad, salida y de página. La API de servicios de ClickBank solamente acepta parámetros de consulta; se ignoran las solicitudes que se utilizaron según parámetros (de envío) de formulario. La especificación de HTTP establece que una dirección URL no puede tener más de 2000 caracteres de longitud. Los programadores de la API deben asegurarse de que la longitud las direcciones URL del tipo REST de la API tengan menos de 2000 caracteres.

Certificación

Con algunos de los idiomas de programación, la API de servicios de ClickBank requerirá que su sistema tenga un certificado para el siguiente dominio: *.clickbank.com Para adquirir el certificado, simplemente vaya a la dirección URL que figura a continuación, haga doble clic en el bloqueo de autenticación en la esquina inferior derecha de su explorador y guarde el certificado en su sistema.

https://api.clickbank.com/rest/1.3/orders2

 

Seguridad

Los métodos de la API de servicios de ClickBank son seguros y enviarán un código de estado 403 [Prohibido] si se intenta acceder sin las credenciales correctas. Un acceso seguro a la API requiere un parámetro del encabezado Autorizacióncon las siguientes claves:

  • Clave de programador. La clave de programador concede al usuario el rol "ROLE_HAS_DEVELOPER_KEY".
  • Clave asistente del usuario. La clave del asistente concede al usuario el rol "ROLE_API_ORDER_READ" o "ROLE_API_ORDER_WRITE".

Conceptualmente, una clave de programador es un componente léxico de programación que se usa por lo general para permitir el acceso a las interfaces de programación de aplicaciones (API); mientras que a una clave API asistente del usuario se la asocia por lo general con un usuario particular. Al crear el parámetro del encabezado con ambos roles, cada valor debe estar separado por dos puntos. Ejemplo:

Autorización

DEV-F7F8023A486E9A9602FFDA2765E1925:API-9870acb8d96f8bd18c2eb70725b01fe4b98ece58

Algunas de la interfaces de programación de aplicaciones (API) de servicios de ClickBank (en especial el sandbox) no requieren ambas claves. La documentación admitida de la API contiene una lista con los roles requeridos para acceder a un servicio particular. Si solo se requiere una clave de programador, no se necesitan los dos puntos en el parámetro del encabezado. Ejemplo:

Autorización

DEV-F7F8023A486E9A9602FFDA2765E1925

Para adquirir las claves de programador y de asistente, simplemente inicie sesión en su cuenta ClickBank y vaya a la ficha Configuración de la cuenta. Luego haga clic en "editar" en las áreas de claves API de programador y de asistente. Cada clave debe estar aprobada, presente y activa para que ocurra satisfactoriamente la autenticación.

Salida

La interfaz de programación de aplicaciones (API) de servicios de ClickBank admite los siguientes formatos de salida:

  • XML
  • JSON
  • CSV (solo funciona con la API de pedidos)

Solicite el formato de salida al incluir un parámetro Aceptoen el encabezado http. Si se solicita un formato no admitido, el servidor proporcionará un código de estado 500 [Error interno del servidor]. Ejemplo:

Aceptar

application/xml

Paginación

La API no enviará más de 100 filas por ninguna llamada de servicio. Para solicitudes que contienen más de 100 filas de datos, la API enviará las primeras 100 filas con un código de estado 206 [Contenido parcial]. Para recuperar las páginas adicionales, el desarrollo debe incluir un parámetro de encabezado Página en el que se establezca cuál es la página del encabezado que se desea. 
Ejemplo:

Página

3

Una vez que se haya accedido a la última página, el servicio enviará un código 200 [OK] instead of a 206 [Partial Content].

Límites API de ClickBank

La API de ClickBank recibe un gran número de operaciones. Para proteger el sistema del posible riesgo de recibir de más operaciones de las que pueda manejar, y para garantizar una distribución equitativa de los recursos del sistema, es necesario emplear un sistema de cifras. Nuestras políticas son las siguientes y en apoyo de los Términos de Servicio API. Nota: Estos están sujetos a cambios.

Todas las aplicaciones en un único proyecto comparten ningún límite por proyecto.

Cifras generales para API:

•        25.000 solicitudes diarias por cuenta
•        10 consultas por segundo (QPS) por IP

Si se supera la cifra, ClickBank API devolverá un mensaje de error por solicitudes adicionales: código de estado HTTP 403 Forbidden y un mensaje que indicará que la cuenta ha superado la cifra especificada y que no puede proceder.

Interfaces de programación de aplicaciones (API) admitidas

Para la versión 1.2, se admitirán las siguientes interfaces de programación de aplicaciones (API):

API de informes analíticos: https://api.clickbank.com/rest/1.3/analytics

  • La API de informes analíticos le permite obtener información sobre subscripciones y estadísticas sobre una cuenta en particular.

API de imágenes: https://api.clickbank.com/rest/1.3/images

  • La API de Imágenes está relacionada con API de Producto según las listas de imágenes asociadas a un sitio.

API de pedidos: https://api.clickbank.com/rest/1.3/orders2

  • La API de pedidos le permite obtener información de un pedido por medio de los parámetros de recibo, la fecha y hora.

API de productos:  https://api.clickbank.com/rest/1.3/products

  • La API de productos le permite llevar a cabo todas las opciones de gerencia de productos (CRUD).

API de Envío: https://api.clickbank.com/rest/1.3/shipping2

  • La API de Envío le permite obtener información del envío para uno o más pedidos de productos físicos por medio de los parámetros de recibo, la fecha o la hora.

API de Billetes: https://api.clickbank.com/rest/1.3/tickets

  • La API de Billetes le permite actualizar el estado de un pedido a devuelto o cancelado por medio de la creación de un billete de transacción. Además, se puede buscar billetes actuales usando el usuario.

API de Notificación de envío: https://api.clickbank.com/rest/1.3/shipping2/shipnotice

  • Esta notificación de API se deriva de API de Información de envío y le permite generar notificaciones de envío.

API para Resumen de Estadísticas: https://api.clickbank.com/rest/1.3/quickstats

  • Esta función provee estadisticas de la cuenta del usuario.

Cada API de ClickBank se describe a sí misma. Para una descripción de los detalles del servicio, simplemente acceda a la dirección URL de la API.

 

Herramientas adicionales

Depuración

La API de ClickBank proporciona un servicio web de depuración [/rest/1.3/debug]. El servicio imprime la información de contexto de la solicitud [lo que incluye información del contexto de seguridad], que puede ser muy útil al corregir temas de la API REST.

Muestras de códigos

Las siguientes muestras de códigos demuestran cómo un programador puede utilizar las interfaces de programación de aplicaciones (API):

¿Tiene más preguntas? Enviar una solicitud

0 Comentarios

Inicie sesión para dejar un comentario.
Tecnología de Zendesk