Download the PHP package compropago/php-sdk without Composer
On this page you can find all versions of the php package compropago/php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download compropago/php-sdk
More information about compropago/php-sdk
Files in compropago/php-sdk
Package php-sdk
Short Description PHP SDK for ComproPago API
License Apache-2.0
Homepage https://github.com/compropago/compropago-php
Informations about the package php-sdk
ComproPago API - PHP SDK
Introducción
Con ComproPago puede recibir pagos vía SPEI y en efectivo.
La librería de ComproPago PHP SDK
le permite interactuar con el API de ComproPago en su aplicación.
También cuenta con los métodos necesarios para facilitarle su desarrollo por medio de los servicios
más utilizados.
Índice de contenidos
- Ayuda y soporte de ComproPago
- Requerimientos
- Instalación
- Guía básica de uso
- Métodos base del SDK
- Enviar instrucciones por SMS
- Webhooks
Ayuda y soporte de ComproPago
Puede obtener información acerca de nuestros servicios en alguno de los siguientes enlaces:
- Centro de ayuda y soporte
- Solicitar integración
- Guía para empezar a usar ComproPago
- Información de contacto
En caso de tener alguna pregunta o requerir el apoyo técnico, por favor contacte al correo: [email protected] y proporcionando la siguiente información:
- Nombre completo del propietario de la cuenta.
- URL del sitio web de la tienda.
- Teléfono local o celular.
- Correo electrónico del propietario de la cuenta.
- Texto detallado de la duda o requerimiento.
- En caso de presentar algún problema técnico, por favor enviar capturas de pantalla o evidencia para una respuesta más efectiva.
Requerimientos
Instalación
Instalación por Composer
Puede descargar el SDK directamente desde el repositorio de Composer con el siguiente comando:
O si lo prefiere, puede incluir directamente en su archivo composer.json
el siguiente código:
Posteriormente deberá instalar las dependencias usando el siguiente comando:
Instalación por Github
Puede descargar alguna de las versiones que hemos publicado aquí:
O si lo desea puede clonar nuestro repositorio de la siguiente forma:
Guía básica de uso
Se debe contar con una cuenta activa de ComproPago.
Importación
Uso básico de la libreria
Para poder hacer uso del SDK y procesar las llamadas al API, es necesario que configurar sus llaves de conexión y crear un instancia de Cash o Spei. Sus llaves las encontrara en su Panel de ComproPago en el menú Configuración.
Instacia de objecto Spei para cobros mediante transferencia
Instacia de objecto Cash para cobros en efectivo
Métodos base del SDK
Ordenes de pago mediante trasferencia (SPEI)
Crear una nueva orden de pago
Verificar el estatus de la orden
Ordenes de pago en efectivo
Listar proveedores para pago en efectivo
Crear una nueva orden de pago en efectivo
Verificar el estatus de la orden
Enviar instrucciones por SMS
Para poder enviar las instrucciones de pago mediante mensajes SMS, deberá crear
una instancia del objecto SMS
y porsteriormente configurar sus llaves de acceso.
Webhooks
Los webhooks son de suma importancia para el procesamiento de las ordenes de ComproPago, estos se encargaran de recibir las notificaciones del cambio en los estatus en las ordenes de compra generadas; también deberán contener parte de la lógica de aprobación en su tienda en linea. El proceso que siguen es el siguiente.
- Cuando una orden cambia su estatus, nuestra plataforma le notificara a cada una de las rutas registradas.
- Dicha notificacion cuenta con la información de la orden modificada en formato JSON.
Los webhooks registrados se pueden visualizar en el panel de ComproPago
Para poder acceder a las funciones del API que controlan los webhook,
deberá crear una instancia del objecto Webhook
.