Descarga loyalty php sdk - Descarga de código fuente loyalty php sdk

loyalty php sdk

Otras categorias

4.1.0

Descargar

lealtad-php-sdk

loyalty php sdk es una herramienta para trabajar con el programa de fidelización de aplicaciones REST-API Bitrix24 y tarjetas de bonificación para Bitrix24 CRM

La aplicación de fidelización agrega una tarjeta de bonificación para el perfil del cliente Bitrix24 en CRM
La aplicación de fidelización admite transacciones para operaciones de pago y acumulación.
porcentaje de descuento de la tienda
operaciones con tarjetas: crear, leer, borrar, bloquear

Documentación

Documentación REST-API

Instalación

Vía compositor

$ composer require b24io/loyalty-php-sdk

Versiones

lealtad-php-sdk versión	estado de soporte	API REST versión	PHP versiones
v4.x	? activo	2	`8.2` , `8.3`
v3.x	? solo corrección de errores	2	`7.4`
v2	? fin de la vida ☠️	1	`7.4`
v1	? fin de la vida ☠️	1	`7.4`

Requisitos

loyalty php sdk funciona con PHP 8.2 o superior, necesita soporte ext-json y ext-curl

Autenticación con roles de administrador y usuario.

SDK puede funcionar con dos roles:

admin : puede trabajar con todas las tarjetas de su cuenta y de la instancia de la aplicación de fidelización
user - sólo puede trabajar con su propia tarjeta

Trabajamos con muchas cuentas, cada cuenta tiene una CLIENT_API_KEY Si desea trabajar en el rol de administrador, debe usar ADMIN_API_KEY para firmar consultas. Si desea trabajar con la función de cliente en JS, debe utilizar CLIENT_API_KEY y CARD_UUID como clave API de usuario.

Entidades de dominio disponibles desde REST-API

Leyenda

✅ — disponible mediante rest-api e implementado en PHP-SDK
? — disponible con rest-api y no implementado en PHP-SDK
- no implementado en rest-api

Tarjetas

Trabajar con tarjeta como rol admin

Método	Estado	Descripción
`list`	✅	obtener lista de tarjetas con navegación de página
`getById`	✅	obtener tarjeta por uuid
`count`	✅️	contar cartas
`delete`		eliminar tarjeta por uuid
`add`	✅️	agregar nueva tarjeta
`block`	️	bloquear tarjeta por uuid
`unblock`	️	desbloquear tarjeta por uuid
`setLevel`	️	establecer nivel de tarjeta por uuid
`setPercentage`	️	establecer porcentaje de tarjeta por uuid

Trabajar con tarjeta como rol user

Método	Estado	Descripción
`getById`	?	obtener tarjeta por uuid

Si necesita exportar todas las tarjetas, puede usar CardsFetcher

Niveles de tarjeta

Trabajar con niveles de tarjeta como rol admin

Método	Estado	Descripción
`list`	?	obtener lista de niveles de tarjeta
`add`	?	agregar nuevo nivel de tarjeta
`delete`	?	eliminar nivel de tarjeta
`update`	️	actualizar nivel de tarjeta

Actas

Trabaje con transacciones como rol admin .

El servicio de transacciones contiene métodos, el método de lista funciona con paginación

Método	Descripción
`list`	obtener lista de transacciones para todas las tarjetas con paginación
`count`	contar transacciones
`getByCardNumber`	obtener lista de transacciones para el número de tarjeta actual
`processAccrualTransactionByCardNumber`	procesar transacción de acumulación
`processPaymentTransactionByCardNumber`	procesar transacción de pago

Si desea leer todas las transacciones sin paginación, puede trabajar con TransactionsFetcher . Todos los métodos de recuperación generan retornos, bajo el capó el buscador usa la paginación.

Método	Descripción
`list`	obtener lista de transacciones para todas las tarjetas
`listByCardNumber`	enumerar todas las transacciones de la tarjeta actual

Trabajar con transacciones como rol user

Método	Estado	Descripción
`getByCardId`	?	obtener lista de transacciones para la tarjeta actual

Contactos

Trabajar con contactos como rol admin

Método	Estado	Descripción
`list`	✅	obtener lista de contactos
`getById`	✅	obtener contacto por identificación
`add`	✅	agregar nuevo contacto
`update`	️	actualizar contacto
`delete`	️	eliminar contacto
`count`	✅	contar contactos
`startAuthByPhone`	️	iniciar intento de autenticación por teléfono
`finishAuth`	️	finalizar el intento de autenticación

Trabajar con contactos como rol user

Método	Estado	Descripción
`getById`	?	obtener contacto por identificación
`startAuthByPhone`	?	iniciar intento de autenticación por teléfono
`finishAuth`	?	finalizar el intento de autenticación

Si necesita exportar todos los contactos, puede usar ContactsFetcher

Compañía

Trabajar con la empresa como admin

Método	Estado	Descripción
`current`		obtener la empresa actual
`add`	️	agregar empresa
`update`	️	actualizar empresa
`delete`	️	eliminar empresa

Trabajar con la empresa como rol user

Método	Estado	Descripción
`current`	?	obtener la empresa actual

Diario de aplicación

Trabajar con el diario de aplicaciones como función admin

Método	Estado	Descripción
`list`	?	obtener la lista de elementos del diario de aplicación con navegación de página
`getById`	?	obtener elemento del diario de solicitud por identificación

Puntos de contacto

Trabajar con puntos de contacto como función admin

Método	Estado	Descripción
`list`	?	obtener lista de puntos de contacto con navegación de página
`getById`	?	obtener elemento de punto de contacto por identificación
`add`	?	agregar nuevo punto de contacto
`update`	️	actualizar punto de contacto
`delete`		eliminar punto de contacto

Uso básico

Utilidades de línea de comando

Utilidades de línea de comando para trabajar a través de REST-API

php bin/console

cards:export Exportar tarjetas de fidelización a un archivo csv
transactions:bulk-transaction Transacción masiva a todas las tarjetas activas: acumulación o pago
transactions:load-from-file Procesar transacciones desde un archivo csv
transactions:export Exportar transacciones a un archivo csv