• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
API Design for Your Packaged App
 

API Design for Your Packaged App

on

  • 238 views

When building apps for the Salesforce AppExchange, having a well-designed API around your application will draw in the developer audience and make your app more successful. Join us as step-by-step, ...

When building apps for the Salesforce AppExchange, having a well-designed API around your application will draw in the developer audience and make your app more successful. Join us as step-by-step, we'll explore the principles of good API design, including security, ease of use, integration, and adaptability. We'll also give examples of API documentation and specific Force.com guidelines for APIs.

Statistics

Views

Total Views
238
Views on SlideShare
238
Embed Views
0

Actions

Likes
0
Downloads
5
Comments
0

0 Embeds 0

No embeds

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    API Design for Your Packaged App API Design for Your Packaged App Presentation Transcript

    • API Design for Your Packaged App Simon Goodyear, Beaufort 12, CTO @simongoodyear
    • 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 product or service availability, 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, new products and services, 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 outcome of any litigation, risks associated with completed and any possible mergers and acquisitions, 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, our limited history reselling non-salesforce.com products, 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 for the most recent fiscal year and in our quarterly report on Form 10-Q for the most recent fiscal quarter. These documents and others containing important disclosures 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 presentations, 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.
    • Simon Goodyear Beaufort 12, CTO @simongoodyear
    • What Is An API? Application Programming Interface - Definition of how things work together
    • It Is The Same In Code
    • Application Programming? User Interface API Applications Platform, SDK, Framework Language Math, HttpWebRequest, Hashtable Apex, C#, Java
    • Why Build An API? ▪ Reuse • Internally and externally • Economies of scale ▪ Financial gain • Gives users a different way to interact with your IP • API Economy is booming
    • Why Build An API? Ideal World View Real World Controller Model View Mo-troller
    • Why Build An API? Mo-troller World Decoupled World User Interface User Interface API Mo-troller API UI Controller API Controller Model
    • API Design It is not easy. Other developers become dependent on you General Principles ▪ Easy to learn ▪ Easy to use ▪ Hard to break ▪ Just enough ▪ Examples
    • Guiding Principles ▪ Easy to learn - familiar ▪ Easy to use - without documentation ▪ Naming is key
    • Guiding Principles ▪ Hard to break – no one thinks like you do ▪ Make use of available features of the language
    • Guiding Principles ▪ Just enough – great power equals a maintenance nightmare ▪ Keep it simple
    • Guiding Principles ▪ Example code ▪ Each method should have an example ▪ Examples must be perfect ▪ Examples will be copied
    • Guiding Principles ▪ Easy to learn ▪ Easy to use ▪ Hard to break ▪ Just enough ▪ Examples
    • Platform Specific Considerations ▪ Security ▪ Bulkification ▪ Leakage ▪ Documentation
    • Security Consider your licencing model ▪ Unlicenced users will get exceptions ▪ Also remember permissions on installation Sharing model ▪ with / without / implicit ▪ Only you know the action the code is performing
    • Bulkification ▪ Your code contributes to user’s limits ▪ May be called from a trigger ▪ Ensure your code is the same for 1 vs many records
    • Leakage ▪ Details of the implementation cross the interface ▪ Users will use this for control
    • Documentation Limits force us to tell people what we are doing What sort of information? ▪ Batches / futures ▪ Callouts ▪ How to pass a test ▪ SOQL, SOSL, DML Use Limits class
    • Platform specific considerations ▪ Security ▪ Bulkification ▪ Leakage ▪ Documentation
    • Conclusion ▪ This is set to be a recap of what we’ve discussed ▪ Not sure on what’s in and what’s out yet as it feels too long so I’ m holding back on these couple of slides
    • Speaker Name Speaker Name Speaker Name Speaker Name Speaker Title, @twittername Speaker Title, @twittername Speaker Title, @twittername Speaker Title, @twittername
    • We want to hear from YOU! Please take a moment to complete our session survey Surveys can be found in the “My Agenda” portion of the Dreamforce app