The power of Rest API

Transcription

1 The power of Rest API Olena Zhuk and Konrad Cłapa Atos

2 Agenda Who are we? How to start your journey? What is REST API? VMware REST API? Beyond REST API Rest API best practices Quiz with gifts QA BG, KC Atos

3 Who are we Olena Zhuk Technical Atos IT Services Private Cloud Lead Developer olena.zhuk@atos.net BG, KC Atos

4 Who are we Konrad Cłapa Global Technical Atos IT Services Private Cloud Developer Double VCDX # BG, KC Atos

5 How to start the journey?

6 How to start your journey? Watch this presentation Bookmark code.vmware.com Watch vbrownbags API zero to hero Download Postman and play with your own lab and 3rd party APIs Run Hands on Labs BG, KC Atos

7 Key Takeaways Change mindset The power of REST API When to use REST API BG, KC Atos

8 What is RESTful API Application Programming Interface communication interface between computer programs which is built based on REST architectural principles HTTP network communication (most often) mapping CRUD operations (most often) stateless pointing to further resources (should be, not always implemented correctly) payload is NOT restricted to specific format BG, KC Atos

9 What is RESTful API make it simple Used for transmission of data between systems that are platform independent BG, KC Atos

10 How to use REST API POSTMAN SoapUI vro CURL Powershell Python any programming language BG, KC Atos

11 Rest API call Endpoint (URI) Resource/Entity Method Header Body BG, KC Atos

12 Rest API methods (headlights) GET retrieve an entity by URI PUT overwrite an entity POST append child entity to one identified by URI DELETE delete resource identified by URI BG, KC Atos

13 BG, KC Atos

14 Common responses BG, KC Atos

15 REST API vs SOAP SOAP XML Access to services Stateful Built-in retry logic Complex operations More complicate to implement REST JSON, XML, Binary Access to resources Stateless Caching Simple actions Easier in use and implementation BG, KC Atos

16 16 Authentication

17 Authentication Basic NSX vro Oauth 2.0 vsphere vra vro vrops BG, KC Atos

18 Basic authentication BG, KC Atos

19 Oauth BG, KC Atos

20 20 vsphere 6.5 REST API

21 vsphere 6.5 Rest API Brand new! Swagger API Explorer BG, KC Atos

22 DEMO TIME! BG, KC Atos

23 vra/vro Rest API BG, KC Atos

24 vro REST API BG, KC Atos

25 vro REST API BG, KC Atos

26 vro REST API BG, KC Atos

27 vra REST API BG, KC Atos

28 BG, KC Atos

29 NSX Rest API BG, KC Atos

30 Could that be done simpler?

31 Powershell modules Almost as powerful as Rest API Easier to use Not always up to date Most popular modules: PowerCLI PowerVRA PowerVRO PowerNSX BG, KC Atos

32 PowerCLI VMware Supported VMware PowerCLI is a command-line and scripting tool built on Windows PowerShell, and provides more than 600 cmdlets for managing and automating vsphere, vcloud, vrealize Operations Manager, vsan, NSX-T, VMware Cloud on AWS, and VMware Horizon environments. Install Connect-VIServer Rule it all! BG, KC Atos

33 PowerX Created by community Open projects on Github Mimics the way PowerCLI works BG, KC Atos

34 PowerVRO Community supported Invoke-WebRequest and Invoke-RestMethod from Microsoft.PowerShell.Commands.Utility BG, KC Atos

35 PowerVRA Community supported Powershell wrapper for vra REST API Popular module for vra automation BG, KC Atos

36 PowerNSX Comminuty supported+ Not only command-letes Contains some analysis tools Includes operations from Cross-vCenter NSX BG, KC Atos

37 vro Plugins BG, KC Atos

38 38 Best Practices

39 Best practices Map rest responses to your error handling Use one method to deal with resource Use http encoding for special characters Be careful about case-sensitivity Use one media type Develop one method for response parsing and managing retrieved resources Develop common wrapper for creating REST calls Get resource before modifying it to avoid conflicts BG, KC Atos

40 References BG, KC Atos

41 41 QUIZ

42 QA

43 Question 1 What are 4 most often used REST API methods? BG, KC Atos

44 Question 2 What are 2 authentication methods used by VMware products? BG, KC Atos

45 Thank You!