Sample Title. Dancing with the Magento 2 APIs. A guided tour of the API dance floor. DevelopersParadise 2016 / Opatija / Croatia

Transcription

1 Sample Title Dancing with the Magento 2 APIs A guided tour of the API dance floor

2 Bill Curtis CTO - Sweet Tooth

3

4

5

6

7 Overview Use cases for using the Magento 2 API How to make API calls Extending the API Tooling & Resources

8 Use cases What is the Magento API used for?

9 Extensions (PHP) MAGENTO API API Requests ERP CRM POS Apps

10 How to make Magento 2 API calls SOAP vs REST XML vs JSON Overview of CRUD actions Search Authentication

11 SOAP vs REST

12 XML vs JSON

13 REST + JSON

14 Anatomy of the API request

15 Anatomy of the API request

16 Anatomy of the API request

17 Anatomy of the API request

18 Anatomy of the API request

19 Anatomy of the API request

20 Anatomy of the API request

21 REST APIs support CRUD operations Create Read Update Delete

22 Create customer POST V1/customers { } Read customer GET V1/customers/1 Update customer PUT V1/customers/1 { } Delete customer DELETE V1/customers/1

23 CRUD - Create a customer REQUEST RESPONSE POST /rest/v1/customers

24 CRUD - Read a customer REQUEST RESPONSE GET /rest/v1/customers/6

25 CRUD - Update a customer REQUEST RESPONSE PUT /rest/v1/customers/6

26 CRUD - Delete a customer REQUEST RESPONSE DELETE /rest/v1/customers/6

27 REST is an architectural style

28

29

30 What about customer search?

31 Search customers GET V1/customers/search

32 ? GET /V1/cmsPage/search GET /V1/cmsBlock/search GET /V1/customerGroups/search GET /V1/customers/search GET /V1/carts/search GET /V1/salesRules/search GET /V1/coupons/search GET /V1/taxRates/search GET /V1/taxRules/search GET /V1/taxClasses/search GET /V1/products GET /V1/categories

33 Search customers REQUEST RESPONSE GET /V1/customers/search

34 Search customers REQUEST RESPONSE GET /V1/customers/search?searchCriteria=

35 ?searchcriteria= The most powerful query param in the world

36 Search criteria

37 Search criteria

38 Search criteria

39 Search criteria

40 Search for an within a store id

41 Search for an within a store id

42 Search within store id

43 Search for a customer in store 1 AND

44 Search for a yellow OR red product created this year

45 Search for a yellow OR red product created this year

46 Search for a yellow OR red product created this year OR

47 Search for product

48 Search for product AND

49 ?searchcriteria=

50

51

52 Customer Search REQUEST RESPONSE

53 Authentication How do we get this token?

54 3 ways to authenticate 1. Username & Password 2. OAuth 1.0a 3. Session

55 1. Username & Password 2. OAuth 1.0a 3. Session 1st party apps / integrations

56 Username & Password Authentication REQUEST RESPONSE POST /rest/v1/integration/admin/token POST /rest/v1/integration/customer/token

57 Customer API Access PUT GET PUT PUT POST GET /V1/customers/me /V1/customers/me /V1/customers/me/activate /V1/customers/me/password /V1/carts/mine /V1/carts/mine GET /V1/carts/mine/items POST /V1/carts/mine/items PUT /V1/carts/mine/items/:itemId DELETE /V1/carts/mine/items/:itemId

58 1. Username & Password 2. OAuth 1.0a 3. Session 3rd party apps / integrations

59

60

61

62

63

64

65 1. Username & Password 2. OAuth 1.0a 3. Session In browser

66

67 Extending the Magento API etc/webapi.xml

68 etc/webapi.xml

69 etc/webapi.xml

70 etc/webapi.xml

71 etc/webapi.xml

72 Magento Release - March

73

74 Development resources

75

76

77

78

79

80

81

82

83

84 Thank You!