README

SDK oficial para la integración de pagos y suscripciones con Coffee Pay en aplicaciones PHP.

Características

🛡️ Autenticación JWT: Gestión automática de tokens HS256.
💳 Suscripciones: CRUD completo para planes de suscripción.
💰 Monedas: Consulta de monedas soportadas.
🔑 Seguridad: Utilidades para generación de firmas web para el Widget.
📦 PSR-4: Estructura moderna y compatible con Composer.

Requisitos

PHP >= 7.4
Composer

Instalación

Instala el SDK usando Composer:

composer require coffee-pay/sdk

(Nota: Si estás usando el SDK en desarrollo local, asegúrate de configurar el repositorio de tipo path en tu composer.json)

Uso Básico

Inicialización del Cliente

use CoffeePay\Sdk\CoffeeSDK;

$client = new CoffeeSDK([
    'apiKey'    => 'tu_api_key',
    'apiSecret' => 'tu_api_secret',
    'baseUrl'   => 'https://production.coffee-pay.co/api/v1' // Opcional, por defecto apunta a producción
]);

Gestión de Planes de Suscripción

// Listar planes
$plans = $client->subscriptionsPlans->list(10, 1);

// Crear un nuevo plan
$newPlan = $client->subscriptionsPlans->create([
    'name' => 'Plan Mensual Premium',
    'price' => 50000,
    'currencyId' => 'UUID_DE_LA_MONEDA',
    'interval' => 'monthly',
    'intervalCount' => 1,
    // ... otros campos
]);

// Obtener un plan específico
$plan = $client->subscriptionsPlans->get('id-del-plan');

Generación de Firma para el Widget

El SDK incluye una utilidad para generar la firma necesaria para inicializar el GatewayWidget en el frontend:

use CoffeePay\Sdk\Utils\CryptoUtils;

$timestamp = time();
$signature = CryptoUtils::generateWebSignature(
    'tu_account_key',
    'tu_integrity_key',
    $timestamp
);

Estructura del Proyecto

src/CoffeeSDK.php: Punto de entrada principal.
src/Resources/: Handlers para los diferentes endpoints de la API.
src/Utils/: Herramientas de cifrado y autenticación.

Licencia

MIT

coffee-pay / sdk

Maintainers

Package info

Statistics

Security