loyalty php sdk Télécharger - loyalty php sdk Téléchargement du code source

loyalty php sdk

Autres catégories

4.1.0

Télécharger

fidélité-php-sdk

loyalty php sdk est un outil pour travailler avec le programme de fidélité d'application REST-API Bitrix24 et les cartes bonus pour Bitrix24 CRM

L'application de fidélité ajoute une carte bonus pour le profil client Bitrix24 dans CRM
L'application de fidélité prend en charge les transactions pour les opérations de paiement et de régularisation
pourcentage de remise en magasin
opérations avec des cartes : créer, lire, supprimer, bloquer

Documentation

Documentation REST-API

Installation

Via Compositeur

$ composer require b24io/loyalty-php-sdk

Versions

fidélité-php-sdk version	statut de prise en charge	API REST version	PHP versions
v4.x	? actif	2	`8.2` , `8.3`
v3.x	? correction de bugs uniquement	2	`7.4`
v2	? fin de vie ☠️	1	`7.4`
v1	? fin de vie ☠️	1	`7.4`

Exigences

loyalty php sdk fonctionne avec PHP 8.2 ou supérieur, nécessite le support ext-json et ext-curl

Authentification avec les rôles d'administrateur et d'utilisateur

Le SDK peut fonctionner avec deux rôles :

admin - peut travailler avec toutes les cartes de son compte et de son instance d'application de fidélité
user - ne peut travailler qu'avec sa propre carte

Nous travaillons avec de nombreux comptes, chaque compte a un CLIENT_API_KEY Si vous souhaitez travailler dans le rôle d'administrateur, vous devez utiliser ADMIN_API_KEY pour signer les requêtes. Si vous souhaitez travailler avec le rôle client dans JS, vous devez utiliser CLIENT_API_KEY et CARD_UUID comme clé API utilisateur.

Entités de domaine disponibles depuis REST-API

Légende

✅ — disponible via rest-api et implémenté dans PHP-SDK
? - disponible via rest-api et non implémenté dans PHP-SDK
- non implémenté dans rest-api

Cartes

Travailler avec la carte en tant admin

Méthode	Statut	Description
`list`	✅	obtenir la liste des cartes avec la navigation dans les pages
`getById`	✅	obtenir la carte par uuid
`count`	✅️	compter les cartes
`delete`		supprimer la carte par uuid
`add`	✅️	ajouter une nouvelle carte
`block`	️	bloquer la carte par uuid
`unblock`	️	débloquer la carte par uuid
`setLevel`	️	définir le niveau de la carte par uuid
`setPercentage`	️	définir le pourcentage de carte par uuid

Travailler avec la carte en tant que rôle user

Méthode	Statut	Description
`getById`	?	obtenir la carte par uuid

Si vous avez besoin d'exporter toutes les cartes, vous pouvez utiliser CardsFetcher

Niveaux de carte

Travailler avec les niveaux de carte en tant admin

Méthode	Statut	Description
`list`	?	obtenir la liste des niveaux de carte
`add`	?	ajouter un nouveau niveau de carte
`delete`	?	supprimer le niveau de la carte
`update`	️	mettre à jour le niveau de la carte

Transactions

Travaillez avec les transactions en tant que rôle admin .

Le service de transactions contient des méthodes, la méthode de liste fonctionne avec la pagination

Méthode	Description
`list`	obtenir la liste des transactions pour toutes les cartes avec pagination
`count`	compter les transactions
`getByCardNumber`	obtenir la liste des transactions pour le numéro de carte actuel
`processAccrualTransactionByCardNumber`	traiter une transaction de régularisation
`processPaymentTransactionByCardNumber`	traiter une opération de paiement

si vous souhaitez lire toutes les transactions sans pagination, vous pouvez travailler avec TransactionsFetcher Toutes les méthodes de récupération renvoient le générateur, sous le capot, le récupérateur utilise la pagination.

Méthode	Description
`list`	obtenir la liste des transactions pour toutes les cartes
`listByCardNumber`	lister toutes les transactions pour la carte actuelle

Travailler avec des transactions en tant que rôle user

Méthode	Statut	Description
`getByCardId`	?	obtenir la liste des transactions pour la carte actuelle

Contacts

Travailler avec des contacts en tant admin

Méthode	Statut	Description
`list`	✅	obtenir la liste de contacts
`getById`	✅	prendre contact par identifiant
`add`	✅	ajouter un nouveau contact
`update`	️	mettre à jour le contact
`delete`	️	supprimer un contact
`count`	✅	compter les contacts
`startAuthByPhone`	️	lancer une tentative d'authentification par téléphone
`finishAuth`	️	terminer la tentative d'authentification

Travailler avec des contacts en tant que rôle user

Méthode	Statut	Description
`getById`	?	prendre contact par identifiant
`startAuthByPhone`	?	lancer une tentative d'authentification par téléphone
`finishAuth`	?	terminer la tentative d'authentification

Si vous avez besoin d'exporter tous les contacts, vous pouvez utiliser ContactsFetcher

Entreprise

Travailler avec l'entreprise en tant admin

Méthode	Statut	Description
`current`		obtenir l'entreprise actuelle
`add`	️	ajouter une entreprise
`update`	️	mettre à jour la société
`delete`	️	supprimer une entreprise

Travailler avec l'entreprise en tant user

Méthode	Statut	Description
`current`	?	obtenir l'entreprise actuelle

Journal d'application

Travailler avec le journal des candidatures en tant admin

Méthode	Statut	Description
`list`	?	obtenir la liste des éléments du journal d'application avec la navigation dans les pages
`getById`	?	obtenir un élément du journal de candidature par identifiant

Points de contact

Travailler avec des points de contact en tant admin

Méthode	Statut	Description
`list`	?	obtenir la liste des points de contact avec la navigation dans les pages
`getById`	?	obtenir l'élément de point de contact par identifiant
`add`	?	ajouter un nouveau point de contact
`update`	️	mettre à jour le point de contact
`delete`		supprimer le point de contact

Utilisation de base

Utilitaires de ligne de commande

Utilitaires de ligne de commande pour travailler via REST-API

php bin/console

cards:export Exporter les cartes de fidélité vers un fichier CSV
transactions:bulk-transaction Transaction groupée vers toutes les cartes actives : cumul ou paiement
transactions:load-from-file Traiter les transactions à partir d'un fichier csv
transactions:export Exporter les transactions vers un fichier CSV