08 - Bill Curtis - Dancing with the Magento 2 Web APIs · DevelopersParadise 2016 / Opatija /...

Sample Title

DevelopersParadise2016 / Opatija / Croatia

Dancing with the Magento 2 APIsA guided tour of the API dance floor

Bill CurtisCTO - Sweet Tooth

Overview

• Use cases for using the Magento 2 API

• How to make API calls

• Extending the API

• Tooling & Resources

Use casesWhat is the Magento API used for?

Extensions (PHP)

AppsERPPOSCRM

MAGENTO API

API Requests

How to make Magento 2 API calls

• SOAP vs REST

• XML vs JSON

• Overview of CRUD actions

• Search

• Authentication

SOAP vs REST

XML vs JSON

REST + JSON ♥

Anatomy of the API request

Create Read Update Delete

REST APIs support CRUD operations

Delete customer DELETE V1/customers/1

Create customer POST V1/customers {…}

Read customer GET V1/customers/1

Update customer PUT V1/customers/1 {…}

CRUD - Create a customer

POST /rest/V1/customers

REQUEST RESPONSE

CRUD - Read a customer

GET /rest/V1/customers/6

REQUEST RESPONSE

CRUD - Update a customer

PUT /rest/V1/customers/6

REQUEST RESPONSE

CRUD - Delete a customer

DELETE /rest/V1/customers/6

REQUEST RESPONSE

REST is an architectural style

http://devdocs.magento.com/guides/v2.0/rest/list.html

What about customer search?

Search customers GET V1/customers/search

GET /V1/cmsPage/searchGET /V1/cmsBlock/searchGET /V1/customerGroups/searchGET /V1/customers/searchGET /V1/carts/searchGET /V1/salesRules/searchGET /V1/coupons/searchGET /V1/taxRates/searchGET /V1/taxRules/searchGET /V1/taxClasses/search

GET /V1/productsGET /V1/categories

Search customers

GET /V1/customers/search

REQUEST RESPONSE

Search customers

GET /V1/customers/search?searchCriteria=

REQUEST RESPONSE

?searchCriteria=

The most powerful query param in the world

Search criteria

Search for an email within a store id

Search within store id

Search for a customer in store 1

Search for a yellow OR red product created this year

Search for product

?searchCriteria=

Customer Search

REQUEST RESPONSE

Authentication How do we get this token?

1. Username & Password

2. OAuth 1.0a

3. Session

3 ways to authenticate

2. OAuth 1.0a

3. Session

1st party apps / integrations

Username & Password Authentication

POST /rest/V1/integration/admin/token

REQUEST RESPONSE

POST /rest/V1/integration/customer/token

PUT /V1/customers/meGET /V1/customers/mePUT /V1/customers/me/activatePUT /V1/customers/me/password

POST /V1/carts/mineGET /V1/carts/mine

GET /V1/carts/mine/itemsPOST /V1/carts/mine/itemsPUT /V1/carts/mine/items/:itemIdDELETE /V1/carts/mine/items/:itemId

Customer API Access

2. OAuth 1.0a

3. Session 3rd party apps / integrations

2. OAuth 1.0a

3. Session

In browser

Extending the Magento APIetc/webapi.xml

etc/webapi.xml

Magento 2.0.4 Release - March 31 2016

Development resources

http://<magento_host>/rest/default/schema

http://devdocs.magento.com/swagger/

http://devdocs.magento.com/guides/v2.0/rest/list.html

https://luckymarmot.com/paw

https://www.getpostman.com/

Thank You!

08 - Bill Curtis - Dancing with the Magento 2 Web APIs · DevelopersParadise 2016 / Opatija /...

Documents

Transcript of 08 - Bill Curtis - Dancing with the Magento 2 Web APIs · DevelopersParadise 2016 / Opatija /...

Magento Performanceinfo2.magento.com/rs/magentoenterprise/images... · Magento Performance Toolkit . William Harvey Principal Product Manager Magento . Performance Toolkit. Magento

Magento Ecommerce Forum - Increasing ROI with Magento

Dancing - Passion 4 Dancing - Salsa Dancing - Ballroom Dancing - Swing Danc...

Magento 2 Overviewinfo2.magento.com/rs/magentosoftware/images/Magento... · Magento 2 Overview. Paul Boisvert Director Product Management, Magento . Platform Goals . ... Magento UI

Magento Integration Guide - PRWebww1.prweb.com/prfiles/2011/11/13/8961192/Magento... · 2011-11-14 · Magento Integration Guide ... Create Magento API ... Magento allows you to have

NEW MAGENTO SHOP: Magento 1 or Magento 2?

Magento Designer and Outstanding Magento Themes

Magento essentials for clean magento programmers

Magento Development Company - Magento Development India, Magento Development Services

Hire Dedicated Magento Developers | Hire Magento Developers | Hire Magento Developers For Full Time | Hire Magento Developer part time | Full Time Magento Developer

Magento Development Company, PSD to Magento, Magento Customization

Magento overview and how sell Magento extensions

Dancing eyes-dancing feet’ Disease

Extension Installation Guide - Magento...Magento 2 Partial Payment User Guide by Meetanshi Author Meetanshi Keywords magento 2 partial payment, magento 2 part payment, magento 2 emi

04 - Peter Samoilov - How to switch your team to Magento 2 … · 2016-05-10 · DevelopersParadise 2016 / Opatija / Croatia 1. That’s not that old good PHP from Magento 1.x 2.

Magento News @ Magento Meetup Wien 17

Mágikus Magento - Bevezetés a Magento világába

Magento 2 GST India UserGuide by Meetanshi · magento 2 gst, magento 2 gst extension, magento 2 indian gst, magento 2 gst india, magento 2 indian gst extension, magento 2 gst india

netz98 Magento – Das Business-Kompendium€¦ · B2B Edition Magento Commerce Cloud Magento 1 DIE ENTWICKLUNG VON MAGENTO 1 ZU MAGENTO COMMERCE CLOUD ... In ihrem „Magic Quadrant

Hire magento developers | HIRE DEDICATED MAGENTO DEVELOPERS | HIRE MAGENTO DEVELOPER | HIRE MAGENTO DEVELOPERS FOR FULL TIME| MAGENTO DEVELOPER | FULL TIME MAGENTO DEVELOPER | MAGENTO