lifeapps-ecommerce-sdk
TypeScript icon, indicating that this package has built-in type declarations

0.0.3 • Public • Published

Life Apps Commerce SDK

Esta biblioteca implementa as principais funcionalidades e aplicação da Life Apps Commerce.

Implementações do pacote

  • Api de conunicação com o servidor
  • Componentes e provedores de funcionalidades

Instalçao

Acesse a pasta do seu projeto e use o npm ou yarn para instalação do pacote

npm i -S lifeapps-ecommerce-sdk

Exemplo de uso

Faça a importação do pacote usando require ou import

const LifeSDK = require('lifeapps-ecommerce-sdk')

ou

import LifeSDK from 'lifeapps-ecommerce-sdk'

Crie uma instância

const SDK = new LifeSDK('ID-FORNECEDOR','OPCOES-OPICIONAL');

Lista de opções disponiveis:

  • token: token opicional

Ao criar uma instância deve ser informado o id do fornecedor em uso, as options é opcional

API

A comunicação da api é organizada pelos recursos

  • carrosel
  • categoria
  • cliente
  • conteudo
  • empresa
  • fornecedores
  • menu
  • pagamentos
  • pedido
  • produto

Componentes

Componentes dispiníveis

  • barCode
  • geoLocation
  • hardware
  • maps
  • pushNotification
  • share

Alguns componentes estão disponíveis apenas em alguns ambientes, quando não disponível será retornado uma exceção

Aplicação multi ambientes

Quando usado dentro dos projetos lifeapps, esta SDK abstrai as implementações web e mobile, podendo ser aplicada a mesma lógica em multiplos ambientes.

Consultar ambiente

Quando necessário pode ser consultado o ambiente em uso da aplicação.

...(sdk previamente instanciada)

let env = SDK.component.ambiente

O retorno é uma string com os possiveis valores:

  • WEB: aplicação rodando em ambiente web/navegadores
  • MOBILE_WEBVIEW: aplicação rodando em ambiente mobile através de uma webview
  • UNKNOW: aplicação rodando em ambiente desconhecido

Readme

Keywords

none

Package Sidebar

Install

npm i lifeapps-ecommerce-sdk

Weekly Downloads

1

Version

0.0.3

License

ISC

Unpacked Size

106 kB

Total Files

126

Last publish

Collaborators

  • lifeapps