Apex REST API. SUMMER OF APIs. Sandeep Bhanot Developer Alex Toussaint Senior Product

Transcription

1 SUMMER OF APIs Apex REST API Sandeep Bhanot Developer Alex Toussaint Senior Product

2 Got / #forcewebinar Facebook? facebook.com/forcedotcom

3 Safe Harbor Safe harbor statement under the Private Securities Litigation Reform Act of 1995: This presentation may contain forward-looking statements that involve risks, uncertainties, and assumptions. If any such uncertainties materialize or if any of the assumptions proves incorrect, the results of salesforce.com, inc. could differ materially from the results expressed or implied by the forward-looking statements we make. All statements other than statements of historical fact could be deemed forward-looking, including any projections of subscriber growth, earnings, revenues, or other financial items and any statements regarding strategies or plans of management for future operations, statements of belief, any statements concerning new, planned, or upgraded services or technology developments and customer contracts or use of our services. The risks and uncertainties referred to above include but are not limited to risks associated with developing and delivering new functionality for our service, our new business model, our past operating losses, possible fluctuations in our operating results and rate of growth, interruptions or delays in our Web hosting, breach of our security measures, the immature market in which we operate, our relatively limited operating history, our ability to expand, retain, and motivate our employees and manage our growth, new releases of our service and successful customer deployment, and utilization and selling to larger enterprise customers. Further information on potential factors that could affect the financial results of salesforce.com, inc. is included in our annual report on Form 10-K filed on February 24, 2011 and in other filings with the Securities and Exchange Commission. These documents are available on the SEC Filings section of the Investor Information section of our Web site. Any unreleased services or features referenced in this or other press releases or public statements are not currently available and may not be delivered on time or at all. Customers who purchase our services should make the purchase decisions based upon features that are currently available. Salesforce.com, inc. assumes no obligation and does not intend to update these forward-looking statements.

4 Appetizers Introduction to Apex REST Common Use Cases First Course Demo and Code Walkthrough Second Course Technical Fine Print Dessert Resources Q & A

5 It s raining APIs! Apex REST API* Streaming API* REST API Chatter REST API* * Developer Preview

6 What is Apex REST (Developer Preview)? Expose custom Apex logic as RESTful services. Force.com Request Response

7 It is available now in all DE Orgs

8 A Quick REST Primer Representational State Transfer (REST) is a style of software architecture for distributed hypermedia systems such as the World Wide Web In English.. REST = HTTP, Stateless, Uniform Named Resource HTTP verb ( GET, POST, PATCH etc.) + URI = action. Especially popular with Web 2.0/Mobile architectures

9 Apex REST key characteristics Define your own custom Resource URI E.g. Authentication OAuth 2.0 or Session ID (username/password) Built in de/serialization support for JSON and XML Governor Limits Counts against the API request limit for the Org Regular Apex Governor limits apply (e.g. Max. payload size of 3MB)

10 Comparison with other APIs Apex REST Apex SOAP REST API SOAP API Bulk API Protocol REST SOAP/WSDL REST SOAP/ WSDL REST Data Format JSON/XML/ Custom XML JSON/XML XML CSV/XML Client libraries/ tools HTTP client (lightweight) SOAP/WSDL library HTTP client (lightweight) SOAP/WSDL library HTTP client (lightweight) Data Volume Medium Medium Medium Large Very Large Sync/Async Sync Sync Sync Sync Async Service Interface Custom Custom Standard Standard Standard

11 Common use cases for Apex REST Mobile applications Custom code to minimize round trips to the server Complex transactions E.g. Insert Case and child Parts & Labor record(s) in a single transaction Use cases beyond the current REST API E.g. Lead Convert, Bulk DML operations Custom REST API for your business application Reach a broader Web 2.0 developer audience

12 Apex REST early adopters Spanning Cloud WIP - Alex to insert logo and short blurb

13 Apex REST the basics curl H Authorization: OAuth <Session ID> services/apexrest/myaccountsvc/ wu3vc

14 Demo Time: Find Nearby Cases on Android

15 Apex REST Annotations Annotation Description Incoming (urlmapping= <your URL> ) Defines the class as a custom Apex @HttpPut Defines the function to be used with the endpoint with HTTP GET Defines the function to be used with the endpoint with HTTP DELETE Defines the function to be used with the endpoint with HTTP POST Defines the function to be used with the endpoint with HTTP PATCH Defines the function to be used with the endpoint with HTTP PUT Query Parameters Query Parameters POST Data in JSON or XML POST Data in JSON or XML POST Data in JSON or XML

16 Key considerations for Apex REST (Provider) Use with sharing in the Apex REST class to respect data security Use RestRequest and RestResponse classes instead of, or in addition to, method parameters and return types Supported return types and parameter types: Apex primitives SObjects List or Maps of the first two types

17 Key considerations for Apex REST (Consumer) URL mapping relative to services/apexrest/... The Content-Type header set by the client determines JSON vs. XML format (JSON is the default) If your client HTTP library does not support PATCH, use POST and add the?_httpmethod=patch query param to the Request URI

18 Key considerations for Apex REST (Consumer) The name and order of the method parameters matter Use a JSON library that respects the element order (e.g. for Java) Apex REST Service Parameter names are case sensitive Sample JSON Request Null/blank values have to be included for optional parameters Parameter order has to be maintained in the JSON/XML request data

19 The RestRequest and RestReponse classes Use to access request/response HTTP headers, cookies etc. Use if you don t want the platform to perform automatic serialization/de-serialization of the request/response data

20 Apex REST best practices REST URI naming best practices Add versioning in the URI Use with sharing to respect data security rules Enable access for the Apex REST service Class for all User Profiles that will invoke the service Bulkify the service code to minimize traffic (and save API calls)

21 Resources Landing page Apex REST Developer s guide Introducing Apex REST services article Using Node.js with Apex REST Apex REST sample from the Summer 11 webinar Discussion Boards (REST Development)

22 Sessions at Dreamforce 2011 What's New in the Force.com REST API

23

24 Questions?