Book Image

Magento 2 Developer's Guide

Book Image

Magento 2 Developer's Guide

Overview of this book

Magento is one of the most exciting, flexible, and customizable e-commerce systems. It offers you an extensive suite of powerful tools for creating and managing an online store. After years of development, Magento 2 introduces itself with a strong emphasis on modularity, Web API's, automated testing and overall new technology stack platform.The long-awaited Magento 2 release introduces a whole new e-commerce platform to develop online stores. The all new Magento 2 architecture, Web APIs, and a host of other features are equally challenging to master as much as they are exciting to use. Tshis book will ease the learning curve by offering step-by-step guidance on how to extend the core functionality of your Magento 2 store. This book is your one-stop guide to build and customize a quality e-commerce website from the latest version of one of the largest, fastest growing, and most popular e-commerce platforms—Magento 2. We start off with an introduction to the fundamental concepts of Magento to give you a foundation to work from. We then move on to configure the development and basic production environment for Magento. After this, you’ll get to grips with the major concepts and conventions that are new to the Magento 2 platform. We then delve deeper to get to the core of automated deployments, persisting data, writing data fixture scripts and applying various backend and frontend modifications. As we near the end of the book, you will learn to make API calls and write automated tests. Finally, you will be guided through building a full-blown helpdesk module from scratch. By the end of this book, you will have learned a wide range of techniques to extend and customize your Magento 2 store to fit the requirements of your business.

Related Content you might be interested in

Current Title:

Small book image
Magento 2 Developer's Guide
Dec, 2015 | 412 pages
No titles found
Table of Contents (19 chapters)
Magento 2 Developer's Guide
Magento 2 Developer's Guide
Credits
Credits
About the Author
About the Author
About the Reviewer
About the Reviewer
www.PacktPub.com
www.PacktPub.com
Preface
Preface
Free Chapter
1
Understanding the Platform Architecture
Understanding the Platform Architecture
The technology stack
The architectural layers
The top-level filesystem structure
The module filesystem structure
Summary
2
Managing the Environment
Managing the Environment
Setting up a development environment
Setting up a production environment
Summary
3
Programming Concepts and Conventions
Programming Concepts and Conventions
Composer
Service contracts
Code generation
The var directory
Coding standards
Summary
4
Models and Collections
Models and Collections
Creating a miniature module
Understanding the flow of schema and data scripts
Creating an install schema script (InstallSchema.php)
Creating an upgrade schema script (UpgradeSchema.php)
Creating an install data script (InstallData.php)
Creating an upgrade data script (UpgradeData.php)
Entity CRUD actions
Creating new entities
Managing collections
Summary
5
Using the Dependency Injection
Using the Dependency Injection
The object manager
Dependency injection
Configuring class preferences
Using virtual types
Summary
6
Plugins
Plugins
Creating a plugin
Using the before listener
Using the after listener
Using the around listener
The plugin sort order
Summary
7
Backend Development
Backend Development
Cron jobs
Notification messages
Session and cookies
Logging
The profiler
Events and observers
Cache(s)
Widgets
Custom variables
i18n
Indexer(s)
Summary
8
Frontend Development
Frontend Development
Rendering flow
View elements
Summary
9
The Web API
The Web API
User types
Authentication methods
REST versus SOAP
Hands-on with token-based authentication
Hands-on with OAuth-based authentication
OAuth-based Web API calls
Hands-on with session-based authentication
Creating custom Web APIs
Search Criteria Interface for list filtering
Summary
10
The Major Functional Areas
The Major Functional Areas
CMS management
Catalog management
Customer management
Products and customers import
The custom product types
Custom offline shipping methods
Custom offline payment methods
Summary
11
Testing
Testing
Types of tests
Unit testing
Integration testing
Static testing
Integrity testing
Legacy testing
Performance testing
Functional testing
Writing a simple unit test
Summary
12
Building a Module from Scratch
Building a Module from Scratch
Module requirements
Registering a module
Creating a configuration file (config.xml)
Creating e-mail templates (email_templates.xml)
Creating a system configuration file (system.xml)
Creating access control lists (acl.xml)
Creating an installation script (InstallSchema.php)
Managing entity persistence (model, resource, collection)
Building a frontend interface
Building a backend interface
Creating unit tests
Summary
Index
Index

OAuth-based Web API calls

Once we have obtained OAuth access token, from the preceding steps, we can start making Web API calls to other methods. Even though the Web API coverage is the same for both REST and SOAP, there is a significant difference when making method calls.

For the purpose of giving a more robust example, we will be targeting the customer group save method, (partially) defined in the vendor/magento/module-customer/etc/webapi.xml file as follows:

<route url="/V1/customerGroups" method="POST">
    <service class="Magento\Customer\Api\GroupRepositoryInterface" method="save"/>
    <resources>
        <resource ref="Magento_Customer::group"/>
    </resources>
</route>

To use the access token to make Web API calls, like POST /V1/customerGroups, we need to include these request parameters in the authorization request header in the call:

  • oauth_consumer_key, available from the Magento admin area, under the integration edit screen.

  • oauth_nonce, random...

Previous Section
End of Section 7
Next Section