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

AND


Search for a yellow OR red product created this year


Search for a yellow OR red product created this year

OR


Search for product


Search for product

AND


?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 /...