loyalty php sdk Download - loyalty php sdk download do código-fonte

loyalty php sdk

Outras categorias

4.1.0

Baixar

fidelidade-php-sdk

loyalty php sdk é uma ferramenta para trabalhar com REST-API Bitrix24 Application Loyalty Program e cartões de bônus para Bitrix24 CRM

Aplicativo de fidelidade adiciona cartão bônus para perfil de cliente Bitrix24 no CRM
Transações de suporte do aplicativo de fidelidade para operações de pagamento e acumulação
porcentagem de desconto da loja
operações com cartões: criar, ler, excluir, bloquear

Documentação

Documentação da API REST

Instalação

Através do Compositor

$ composer require b24io/loyalty-php-sdk

Versões

fidelidade-php-sdk versão	status de suporte	API REST versão	PHP versões
v4.x	? ativo	2	`8.2` , `8.3`
v3.x	? apenas correção de bug	2	`7.4`
v2	? fim da vida ☠️	1	`7.4`
v1	? fim da vida ☠️	1	`7.4`

Requisitos

loyalty php sdk funciona com PHP 8.2 ou superior, precisa de suporte ext-json e ext-curl

Autenticação com funções de administrador e usuário

O SDK pode funcionar com duas funções:

admin - pode trabalhar com todos os cartões em sua conta e instância do aplicativo de fidelidade
user - só pode trabalhar com seu próprio cartão

Trabalhamos com muitas contas, cada conta tem um CLIENT_API_KEY Se você quiser trabalhar na função de administrador você deve usar ADMIN_API_KEY para assinar consultas. Se você quiser trabalhar com função de cliente em JS você deve usar CLIENT_API_KEY e CARD_UUID como chave API do usuário.

Entidades de domínio disponíveis na REST-API

Lenda

✅ — disponível via rest-api e implementado em PHP-SDK
? — disponível via rest-api e não implementado no PHP-SDK
- não implementado em rest-api

Cartões

Trabalhar com cartão como função admin

Método	Status	Descrição
`list`	✅	obter lista de cartões com navegação de página
`getById`	✅	obter cartão por uuid
`count`	✅️	contar cartas
`delete`		excluir cartão por uuid
`add`	✅️	adicionar novo cartão
`block`	️	bloquear cartão por uuid
`unblock`	️	desbloquear cartão por uuid
`setLevel`	️	definir o nível do cartão por uuid
`setPercentage`	️	definir porcentagem do cartão por uuid

Trabalhar com cartão como função user

Método	Status	Descrição
`getById`	?	obter cartão por uuid

Se precisar exportar todos os cartões, você pode usar CardsFetcher

Níveis de cartão

Trabalhe com níveis de cartão como função admin

Método	Status	Descrição
`list`	?	obter lista de níveis de cartão
`add`	?	adicionar novo nível de cartão
`delete`	?	excluir nível do cartão
`update`	️	atualizar nível do cartão

Transações

Trabalhe com transações como uma função admin .

O serviço de transações contém métodos, o método de lista funciona com paginação

Método	Descrição
`list`	obter lista de transações para todos os cartões com paginação
`count`	contar transações
`getByCardNumber`	obter lista de transações para o número do cartão atual
`processAccrualTransactionByCardNumber`	processar transação de acumulação
`processPaymentTransactionByCardNumber`	processar transação de pagamento

se você quiser ler todas as transações sem paginação, você pode trabalhar com TransactionsFetcher Todos os métodos do buscador retornam o gerador, nos bastidores o buscador usa paginação.

Método	Descrição
`list`	obter lista de transações para todos os cartões
`listByCardNumber`	listar todas as transações do cartão atual

Trabalhar com transações como uma função user

Método	Status	Descrição
`getByCardId`	?	obter lista de transações para o cartão atual

Contatos

Trabalhe com contatos como uma função admin

Método	Status	Descrição
`list`	✅	obter lista de contatos
`getById`	✅	obter contato por id
`add`	✅	adicionar novo contato
`update`	️	atualizar contato
`delete`	️	excluir contato
`count`	✅	contar contatos
`startAuthByPhone`	️	iniciar tentativa de autenticação por telefone
`finishAuth`	️	terminar tentativa de autenticação

Trabalhar com contatos como uma função user

Método	Status	Descrição
`getById`	?	obter contato por id
`startAuthByPhone`	?	iniciar tentativa de autenticação por telefone
`finishAuth`	?	terminar tentativa de autenticação

Se precisar exportar todos os contatos, você pode usar ContactsFetcher

Empresa

Trabalhe com a empresa como uma função admin

Método	Status	Descrição
`current`		obter empresa atual
`add`	️	adicionar empresa
`update`	️	atualizar empresa
`delete`	️	excluir empresa

Trabalhar com a empresa como uma função user

Método	Status	Descrição
`current`	?	obter empresa atual

Diário de Aplicação

Trabalhe com o diário do aplicativo como uma função admin

Método	Status	Descrição
`list`	?	obter lista de itens do diário do aplicativo com navegação de página
`getById`	?	obter item do diário do aplicativo por ID

Pontos de contato

Trabalhe com pontos de contato como função admin

Método	Status	Descrição
`list`	?	obter lista de pontos de contato com navegação de página
`getById`	?	obter item de ponto de contato por ID
`add`	?	adicionar novo ponto de contato
`update`	️	atualizar ponto de contato
`delete`		excluir ponto de contato

Uso Básico

Utilitários de linha de comando

Utilitários de linha de comando para trabalho via REST-API

php bin/console

cards:export Exportar cartões de fidelidade para arquivo csv
transactions:bulk-transaction Transação em massa para todos os cartões ativos: acumulação ou pagamento
transactions:load-from-file Processa transações do arquivo csv
transactions:export Exportar transações para arquivo csv