La gema de ComproPago Ruby SDK le permite interactuar con el API de ComproPago en su aplicación.
También cuenta con los métodos necesarios para facilitar el desarrollo por medio de los servicios
más utilizados (SDK).
Con ComproPago puede recibir pagos en 7Eleven, Extra y más tiendas en todo México.
- Ayuda y soporte de ComproPago
- Requerimientos
- Instalación ComproPago SDK
- Documentación
- Guía básica de uso
- Guía de versiones
- Centro de ayuda y soporte
- Solicitar integración
- Guía para comenzar a utilizar ComproPago
- Información de contacto
- Ruby Gems
- Ruby >= 1.9
Puede instalar directamente la gema con el comando siguiente:
gem install compropago_sdkO puede optar por agregarlo a su lista de dependencias dentro de su archivo Gemfile de la siguiente forma:
gem 'compropago_sdk'Puedes descargar alguna de las versiones que hemos publicado:
O si lo deseas puedes obtener el repositorio
#repositorio en su estado actual (*puede no ser versión estable*)
git clone https://github.com/compropago/compropago-ruby.gitFinalizada la descarga del código de la gema descomprime el archivo descargado e ingresa en la carpeta resultante. En una terminal con los siguientes comandos:
# Desinstalará cualquier versión anterior del la gema
sudo gem uninstall compropago*
# Generación del nuevo compilado de la gema
gem build compropago.gemspec
# Instalación del nuevo compilado
sudo gem install compropago*.gemComproPago te ofrece un API tipo REST para integrar pagos en efectivo en tu comercio electrónico o tus aplicaciones.
Información de Horarios y Comisiones, como Transferir tu dinero y la Seguridad que proporciona ComproPAgo
- Botón de pago
- Modo de pruebas/activo
- WebHooks
- Librerías y Plugins
- Shopify
Se debe tener una cuenta activa de ComproPago.
Para poder hacer uso de la librería es necesario incluir la librería principales de la gema
require 'compropago_sdk'Para hacer uso de la gema y llamados al API es necesario que primero configures tus Llaves de conexión y crees un instancia de Client. Tus llaves las encontraras en su Panel de ComproPago en el menú Configuración.
# @param string publickey Llave publica correspondiente al modo de la tienda
# @param string privatekey Llave privada correspondiente al modo de la tienda
# @param bool live Modo de la tienda (false = Test | true = Live)
client = Client.new(
'pk_test_5989d8209974e2d62', # publickey
'sk_test_6ff4e982253c44c42', # privatekey
false # live
)Consulta la documentación de la librería Ruby de ComproPago para conocer más de sus capacidades, configuraciones y métodos.
Para poder hacer uso de los servicios de ComproPago, solo debes llamar a los métodos contenidos en la propiedad api de la variable client como se muestra a continuación.
# @param [string|number] order_id Identificador interno de la orden
# @param [string] order_name Nombre de la orden, productos o servicio
# @param [float] order_price Monto de la orden
# @param [string] customer_name Nombre del cliente
# @param [string] customer_email Email del cliente
# @param [string] payment_type (default = SEVEN_ELEVEN) Tienda en la cual se realizara el deposito (internal_name de objetos Provider)
# @param [string] currency (default = MXN) Divisa de la moneda para elcobro (USD, EUR, GBP, MXN)
# @param [int] expiration_time (default = nil) Fecha en formato Epoch para marcar la expiración de la orden
order_info = {
order_id: 123,
order_name: 'M4 unit ruby',
order_price: 123.45,
customer_name: 'Eduardo Aguilar',
customer_email: '[email protected]',
payment_type: 'SEVEN_ELEVEN',
currency: 'MXN',
expiration_time: 1484786210
}
order = Factory::get_instance_of 'PlaceOrderInfo', order_info
# Llamada al método 'place_order' del API para generar la órden
# @param [PlaceOrderInfo] order
# @return [NewOrderInfo]
new_order = client.api.place_order order# @param [PlaceOrderInfo] info
# @return [NewOrderInfo]
def place_order(info)
endPara verificar el estatus de una órden generada es necesario llamar al método verify_order que provee el atributo api del objeto Client y el cual regresa una instancia CpOrderInfo. Este método recibe como parámetro el ID generado por ComproPago para cada orden. Tambien puede obtener este ID desde un objeto NewOrderInfo accediendo al atributo id.
# Guardar el ID de la orden
order_id = "ch_xxxx_xxx_xxx_xxxx";
# U obtenerlo de un objetdo NewOrderInfo
order_id = new_order.id
# Se manda llamar al metodo del API para recuperar la informacion de la orden
info = client.api.verify_order order_id# @param [String] id
# @return [CpOrderInfo]
def verify_order(id)
endPara obtener el listado de Proveedores disponibles para realizar el pago de las ordenes es necesario consultar el método list_providers que se encuentra alojado en el atributo api del objeto Client y el cual regresa una instancia de tipo Array la cual contendrá objetos de tipo Provider
providers = client.api.list_providers# @param [float] limit
# @param [string] currency
# @return [array]
def list_providers(limit = 0, currency = 'MXN')
endPara realizar el el envío de las instrucciones de compra vía SMS es necesario llamar al método send_sms_instructions que se que se encuentra alojado en el atributo api del objeto Client y el cual regresa una instancia de tipo SmsInfo
# Número al cual se enviaran las instrucciones
phone_number = "55xxxxxxxx";
# Id de la órden de compra de cual se enviaran las instrucciones
order_id = "ch_xxxxx-xxxxx-xxxxx-xxxxx";
# Llamada al método del API para envío de las instrucciones
smsinfo = client.api.send_sms_instructions phone_number , order_id# @param [String] number
# @param [String] id
# @return [SmsInfo]
def send_sms_instructions(number, id)
endLos webhooks son de suma importancia para el proceso las órdenes de ComproPago, ya que ellos se encargaran de recibir las notificaciones del cambio en los estatus de las órdenes de compra generadas, tambien deberán contener parte de la lógica de aprobación en su tienda en línea. El proceso es el siguiente:
- Cuando una órden cambia su estatus, nuestra plataforma le notificará a cada una de las rutas registradas, dicho cambio con la información de la orden modificada en formato JSON.
- Deberá recuperar este JSON en una cadena de texto para posteriormente convertirla a un objeto de tipo CpOrderInfo haciendo uso de la clase Factory que proporciona el SDK de la siguiente forma:
info = Factory.get_instance_of 'CpOrderInfo', cadena_obtenida- Generar la lógica de aprobación correspondiente al estatus de la órden.
Para crear un nuevo Webhook en la cuenta, se debe de llamar al método create_webhook que se encuentra alojado en el atributo api del objeto Client y el cual regresa una instancia de tipo Webhook
# Se pasa como paramtro la URL al webhook
webhook = client.api.create_webhook 'http://sitio.com/webhook'# @param [String] url
# @return [Webhook]
def create_webhook(url)
endPara actualizar la url de un webhook, se debe de llamar al método update_webhook que se encuentra alojado en el atributo api del objeto Client y el cual regresa una instancia de tipo Webhook
updated_webhook = client.api.update_webhook webhook.id, 'http://sitio.com/nuevo_webhook'# @param [String] url
# @param [String] id
# @return [Webhook]
def update_webhook(id, url)
endPara eliminar un webhook, se debe de llamar al método delete_webhook que se encuentra alojado en el atributo api del objeto Client y el cual regresa una instancia de tipo Webhook
deleted_webhook = client.api.delete_webhook webhook.id# @param [String] id
# @return [Webhook]
def delete_webhook(id)
endPara obtener la lista de webhooks registrados en una cuenta, se debe de llamar al método list_webhook que se encuentra alojado en el atributo api del objeto Client y el cual regresa una instancia de tipo Array la cual contiene objetos de tipo Webhook
webhooks = client.api.list_webhooks# @return [Array]
def list_webhooks
end