vinaikopp/module-example-gummypoints

Example GummyPoints API endpoint

Maintainers

Details

github.com/Vinai/module-example-gummypoints

Source

Issues

Installs: 30

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 0

Open Issues: 0

Type:magento2-module

1.0.3 2016-10-18 12:03 UTC

Requires

  • php: ~5.6.0|^7.0.0

BSD-3-Clause 5ea6847f712d23db4f665b0f6a0bb2746415263b

This package is auto-updated.

Last update: 2024-12-07 02:53:28 UTC

README

Very simple example API endpoint for Magento 2

The purpose of this module is to provide an example API endpoint for frontend development examples.

Installation

Install via composer

composer require vinaikopp/module-example-gummypoints ^1.0.0

Usage

The purpose of the module is not to demonstrate a sophisticated endpoint, but rather to provide a simple source of data for doing FPC related experiments and exercises.

API Endpoint: /rest/V1/customer_gummypoints

The API endpoint can only be accessed by logged in customers and will return a random integer value.

API Endpoint: /rest/V1/customer_gummypoints/:customerId

The API endpoint is only open to admins authorized to manage customers. It will return a random integer value.

The module also provides a customer data section with the code customer-gummypoints. It is refreshed during login, logout, checkout/onepage/saveOrder and add to cart actions.