Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ft/add 3ds yape #58

Open
wants to merge 2 commits into
base: fix/php-warnings
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@
Biblioteca PHP oficial de CULQI, pagos simples en tu sitio web.


Esta biblioteca trabaja con la [v2.0](https://culqi.com/api/) de Culqi API.
Esta biblioteca es compatible con la [v2.0](https://culqi.com/api/) del Culqi API.


## Requisitos
## Requisitos

* PHP 5.3 o superiores.
* Credenciales de comercio Culqi (1).
* [Credenciales de comercio Culqi](https://panel.culqi.com) (1).

(1) Debes registrarte [aquí](https://integ-panel.culqi.com/#/registro). Luego, crear un comercio y estando en el panel, acceder a Desarrollo > [***API Keys***](https://integ-panel.culqi.com/#/panel/comercio/desarrollo/llaves).
(1) Debes registrarte [aquí](https://integ-panel.culqi.com/#/registro). Luego, crear un comercio, logearte en tu Culqi Panel y acceder a Desarrollo > [***API Keys***](https://integ-panel.culqi.com/#/panel/comercio/desarrollo/llaves).

![alt tag](http://i.imgur.com/NhE6mS9.png)

## Instalación

### Vía Composer
### 1. Vía Composer
```json
{
"require": {
Expand All @@ -36,7 +36,7 @@ Y cargar todo usando el autoloader de Composer.
require 'vendor/autoload.php';
```

### Manualmente
### 2. Manualmente

Clonarse el repositorio o bajarse el código fuente

Expand All @@ -56,21 +56,24 @@ include_once dirname(__FILE__).'/libraries/culqi-php/lib/culqi.php';

## Modo de uso

En todos ejemplos, inicialmente hay que configurar la credencial `$API_KEY `
Como primer paso hay que configurar la credencial `$API_KEY `

```php
// Configurar tu API Key y autenticación
$SECRET_KEY = "vk9Xjpe2YZMEOSBzEwiRcPDibnx2NlPBYsusKbDobAk";
$culqi = new Culqi\Culqi(array('api_key' => $SECRET_KEY));
```

### Crear un token (Usarlo SOLO en DESARROLLO)
### Crear un token (Usarlo solo en Integración)

Antes de crear un Cargo, Plan o un Suscriptor es necesario crear un `token` de tarjeta. Dentro de esta librería se encuentra una funcionalidad para generar 'tokens', pero solo
debe ser usada para **desarrollo**. Lo recomendable es generar los 'tokens' con **CULQI.JS** cuando pases a producción, **debido a que es muy importante que los datos de tarjeta sean enviados desde el dispositivo de tus clientes directamente a los servidores de Culqi**, para no poner en riesgo información sensible.
Antes de crear un Cargo, Plan o un Suscripción es necesario crear un `token` de tarjeta.
Dentro de esta librería se encuentra una funcionalidad para generar 'tokens', pero solo debe ser usada para el ambiente de **Integración**.

Lo recomendable es generar los 'tokens' con **Checkout v4** o **CULQI.JS v4**, **debido a que es muy importante que los datos de tarjeta sean enviados desde el dispositivo de tus clientes directamente a los servidores de Culqi**, para no poner en riesgo los datos sensibles de la tarjeta de crédito/débito.


### Crear un cargo (Cargos)

Crear un cargo significa cobrar una venta a una tarjeta. Para esto previamente
deberías obtener el `token` que refiera a la tarjeta de tu cliente.

Expand All @@ -88,8 +91,8 @@ $charge = $culqi->Charges->create(
"address" => "Av. Lima 123",
"address_city" => "LIMA",
"country_code" => "PE",
"first_name" => "Will",
"last_name" => "Muro",
"first_name" => "Test_Nombre",
"last_name" => "Test_apellido",
"phone_number" => "9889678986",
),
"source_id" => "{token_id o card_id}"
Expand All @@ -100,6 +103,7 @@ $charge = $culqi->Charges->create(
print_r($charge);
```
### Crear un Plan

```php
$plan = $culqi->Plans->create(
array(
Expand All @@ -119,6 +123,7 @@ print_r($plan);
```

### Crear un Customer

```php
$customer = $culqi->Customers->create(
array(
Expand All @@ -136,6 +141,7 @@ print_r($customer);
```

### Crear un Card

```php
$card = $culqi->Cards->create(
array(
Expand All @@ -147,6 +153,7 @@ print_r($card);
```

### Crear un Suscripción a un plan

```php
// Creando Suscriptor a un plan
$subscription = $culqi->Subscriptions->create(
Expand All @@ -160,7 +167,7 @@ $subscription = $culqi->Subscriptions->create(
print_r($subscription);
```

### Crear un Order
### Crear una Orden

[Ver ejemplo completo](/examples/08-create-order.php)

Expand Down
29 changes: 29 additions & 0 deletions examples/01-create-token-yape.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php
/**
* Ejemplo 1
* Como crear un token Yape con Culqi PHP.
*/

try {
// Usando Composer (o puedes incluir las dependencias manualmente)
require '../vendor/autoload.php';

// Codigo de Comercio
$PUBLIC_KEY = "{PUBLIC KEY}";
$culqi = new Culqi\Culqi(array('api_key' => $PUBLIC_KEY));

// Creando Cargo a una tarjeta
$token = $culqi->Tokens->createYape(
array(
"number_phone" => "900000001",
"otp" => "425251",
"amount" => 700,
"metadata" => array("dni" => "71702935")
)
);
// Respuesta
echo json_encode("Token: ".$token->id);

} catch (Exception $e) {
echo json_encode($e->getMessage());
}