SDK JAVA

Nuestro SDK oficial Python, es compatible con la V2.0 del Culqi API, con el cual tendrás la posibilidad de integrarte con el API de tokens, cargos, devoluciones, clientes, tarjetas, planes, suscripciones y órdenes

El SDK te da la posibilidad de capturar el status_code de la solicitud HTTP que se realiza al API de Culqi, así como el response.

Requisitos

• Nuestro SDK es compatible con Python 2.7+.
• Debes tener tus llaves de producción o integración.
• Si aun no te afilias a Culqi, lo puedes hacer desde aquí.
• Para encriptar el payload debes generar un id y llave RSA ingresando a tu CulqiPanel > Desarrollo > RSA Keys.

Repositorio

Puedes descargar el código fuente del SDK desde:

Repositorio de paquetes

Puedes revisar las versiones disponibles desde el repositorio de paquetes de Python e instalarlo en tu aplicativo como una dependencia:

Instalación

Ejecuta los siguientes comandos en una terminal:

py -m pip install pytest
py -m pip install python-dotenv
py -m pip install culqi
py -m pip install jsonschema
py -m pip install pycryptodome

Configuración

1. Configurar llaves

Para empezar a enviar peticiones al API de Culqi debes configurar tu llave pública (pk), llave privada (sk). Para habilitar encriptación de payload debes configurar tu rsa_id y rsa_public_key.

from dotenv import load_dotenv
from culqi2 import __version__
from culqi2.client import Culqi

self.public_key = "{PUBLIC KEY}"
self.private_key = "{SECRET KEY}"
self.culqi = Culqi(self.public_key, self.private_key)

#encrypt variables
self.rsa_public_key = "{rsa_public_key}"
self.rsa_id = "{rsa_id}"

2. Encriptar payload

Para encriptar el payload necesitas crear un id RSA y llave RSA. Luego envia una petición con el parámetro options que contiene tu id y llave RSA.

Ejemplo

options = {}
options["rsa_public_key"] = self.rsa_public_key #"la llave pública RSA"
options["rsa_id"] = self.rsa_id # "el id de tu llave"
token = self.token.create(data=self.token_data, **options)

Servicios

Crear token

Para no poner en riesgo los datos sensibles de la tarjeta de crédito/débito es recomendable es generar los ‘tokens’ con el Custom Checkout debido a que es muy importante que los datos de la tarjeta sean enviados directamente desde el dispositivo de tus clientes a los servidores de Culqi.

token = self.token.create(data=self.token_data)

Crear cargo

Crear un cargo significa cobrar una venta a una tarjeta. Para esto previamente deberías generar el token y enviarlo en el parámetro source_id.

Los cargos son creados a través del API de cargo.

charge = self.charge.create(data=self.charge_data)

Para realizar un cargo recurrente, puedes utilizar el siguiente código:

charge = self.charge.create(data=self.charge_data, custom_headers={'X-Charge-Channel': 'recurrent'})

Crear devolución

Solicita la devolución de las compras de tus clientes (parcial o total) a través del API y CulqiPanel.

Las devoluciones son creadas a través del API de devolución.

refund = self.refund.create(data=self.refund_data)

Crear Cliente

El cliente es un servicio que te permite guardar la información de tus clientes. Es un paso necesario para generar una tarjeta.

Los clientes son creados a través del API de cliente.

customer = self.customer.create(data=self.customer_data)

Actualizar Cliente

Los clientes son actualizados a través del API de cliente.

updated_customer = self.customer.update(
        id_=created_customer["data"]["id"], data=metadatada
    )

Obtener Cliente

Los clientes son recuperados a través del API de cliente.

 retrieved_customer = self.customer.read(created_customer["data"]["id"])

Crear Card

La tarjeta es un servicio que te permite guardar la información de las tarjetas de crédito o débito de tus clientes para luego realizarles cargos one click o recurrentes (cargos posteriores sin que tus clientes vuelvan a ingresar los datos de su tarjeta).

Las tarjetas son creadas a través del API de tarjeta.

 card = self.card.create(data=self.card_data)

Crear Plan

El plan es un servicio que te permite definir con qué frecuencia deseas realizar cobros a tus clientes.

Un plan define el comportamiento de las suscripciones. Los planes son creados a través del API de Plan o desde el CulqiPanel.

plan = self.plan.create(data=self.plan_data)

Crear Suscripción a un plan

La suscripción es un servicio que asocia la tarjeta de un cliente con un plan establecido por el comercio.

Las suscripciones son creadas a través del API de suscripción.

subscription = self.subscription.create(data=self.subscription_data)

Crear Orden

Es un servicio que te permite generar una orden de pago para una compra potencial. La orden contiene la información necesaria para la venta y es usado por el sistema de PagoEfectivo para realizar los pagos diferidos.

Las órdenes son creadas a través del API de orden.

orden = self.orden.create(data=self.orden_data)

Pruebas

Antes de activar tu tienda en producción, te recomendamos realizar pruebas de integración. Así garantizarás un correcto despliegue.

Si vas a empezar a vender desde tu tienda virtual, deberás seleccionar el ambiente de producción e ingresar tus llaves.

En la caperta /test encontrarás ejemplos para crear un token, charge, plan, órdenes, card, suscripciones, etc.

Ejemplo Prueba Token

 @pytest.mark.vcr()
    def test_token_create(self):
        token = self.token.create(data=self.token_data)
        print(token)
        assert token["data"]["object"] == "token"

Ejemplo Prueba Cargo

 @property
    def charge_data(self):
        # pylint: disable=no-member
        token_data = deepcopy(Data.TOKEN)
        token = self.culqi.token.create(data=token_data)
        print(token)
        charge_data = deepcopy(Data.CHARGE)
        charge_data["source_id"] = token["data"]["id"]

        return charge_data

 @pytest.mark.vcr()
    def test_charge_create(self):
        charge = self.charge.create(data=self.charge_data)
        print (charge)
        assert charge["data"]["object"] == "charge"