DC Convio Users Group Meeting                                July 13, 2011                                           APIs ...
Agenda• Welcome and introductions• Reminder about schedule for rest of 2011• Topic: APIs• Optional: 30 minute session on h...
Welcome and Introductions©2011 Convio, Inc. | Page 3   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
2011 Schedule        DC Users Group forum on Convio Community              Next meeting: September 14 at National         ...
APIs                                             1. What is an API?                   2. When would you want to use one?  ...
What is an API?• Application Programming Interface• An application-programming interface (API) is a  set of programming in...
No, really. What’s that mean?• Tools that allow  applications to  communicate with other                                  ...
Uh, what?• Like the Babel Fish from The  Hitchhiker’s Guide to the  Galaxy• Like the Universal Translator in  Star Trek• L...
APIs allow:• Twitter and Flickr posts to show up on Facebook• A “like” button on your website to talk to  Facebook• An iPh...
©2011 Convio, Inc. | Page 10   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
When Would You Want to Use an API?1. When you want the input form to look different   from a standard Convio form©2011 Con...
A simple HTML                                                                                                    Form calc...
©2011 Convio, Inc. | Page 13   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
Oxfam America©2011 Convio, Inc. | Page 14   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
©2011 Convio, Inc. | Page 15   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
©2011 Convio, Inc. | Page 16   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
When Would You Want to Use an API?1. When you want the input form to look different   from a standard Convio form2. When y...
PETA forms on Facebook©2011 Convio, Inc. | Page 18   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
When Would You Want to Use an API?1. When you want the input form to look different   from a standard Convio form2. When y...
PETA: Action Alerts into txt program©2011 Convio, Inc. | Page 20   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSID...
When Would You Want to Use an API?1. When you want the input form to look different   from a standard Convio form2. When y...
Two-fer©2011 Convio, Inc. | Page 22   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
When Would You Want to Use an API?1. When you want the input form to look different   from a standard Convio form2. When y...
Sustainer Upsell• 2 regular Convio Donation  forms are used as the  backend.• The Renewal form’s  submission button initia...
Mobile Clipboard• Go to www.convio.com/vote2012 on your mobile device©2011 Convio, Inc. | Page 25   PROPRIETARY AND CONFID...
Know This Before Taking the API Plunge• APIs are free like puppies are free• You’ll either need to have your technical sta...
Convio Open APIs• Convio Open APIs provide interfaces for  integrating Convio content into other websites  and creating cu...
open.convio.com©2011 Convio, Inc. | Page 28   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
Downloads©2011 Convio, Inc. | Page 29   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
Downloads©2011 Convio, Inc. | Page 30   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
Web Services©2011 Convio, Inc. | Page 31   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
Free Kits in your DIY Workshop©2011 Convio, Inc. | Page 32   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF C...
Open Community©2011 Convio, Inc. | Page 33   PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
Optional: Stick around for 30 minutes            of “how-to-code-an-API”©2011 Convio, Inc. | Page 34   PROPRIETARY AND CON...
Getting set up• Are you the site admin or have enough  privileges to see Site Options under the Setup  menu? You’ve got so...
Setup > Site Options > Open API                         Configuration©2011 Convio, Inc. | Page 36   PROPRIETARY AND CONFID...
Making a Constituent API CallCommon Name                      Convio Field Name                Type       Value           ...
Sign Up Form – Convio Required<form name="signup_email" id="signup_email" method="POST"   action="https://secure2.convio.n...
Convio extras<input type="hidden" name="success_redirect"  value=“email_signup_thanks” /><input type="hidden" name="error_...
Sign Up Form – Your Information<input type="hidden" name="add_interest_ids" id="add_interest_ids"   value="1126" /><input ...
Handy Links• API Error code list• Open APIs on Community• Open.Convio.com!©2011 Convio, Inc. | Page 41   PROPRIETARY AND C...
Log files!• Convio API Logging Level -- Controls what requests and responses are logged:   •    OFF (no logging)   •    ER...
Mobile Friendly Donation Form• Download on open.convio.com    • Creating a Mobile-Friendly Donations Form with the Convio ...
Upcoming SlideShare
Loading in …5
×

Convio APIs, what are they good for?

1,757 views

Published on

DC Convio Users Group presentation on open.convio.com APIs

Published in: Technology
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
1,757
On SlideShare
0
From Embeds
0
Number of Embeds
4
Actions
Shares
0
Downloads
0
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide
  • Like smartphone apps or lightboxes or mobile clipboards
  • Like smartphone apps or lightboxes or mobile clipboards
  • Convio APIs, what are they good for?

    1. 1. DC Convio Users Group Meeting July 13, 2011 APIs – what are they good for?©2011 Convio, Inc. | Page 1 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    2. 2. Agenda• Welcome and introductions• Reminder about schedule for rest of 2011• Topic: APIs• Optional: 30 minute session on how to code an API [WARNING: GEEK ALERT]• Adjournment©2011 Convio, Inc. | Page 2 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    3. 3. Welcome and Introductions©2011 Convio, Inc. | Page 3 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    4. 4. 2011 Schedule DC Users Group forum on Convio Community Next meeting: September 14 at National Association of REALTORS office Topic: Mobile©2011 Convio, Inc. | Page 4 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    5. 5. APIs 1. What is an API? 2. When would you want to use one? 3. Let’s look at examples in action©2011 Convio, Inc. | Page 5 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    6. 6. What is an API?• Application Programming Interface• An application-programming interface (API) is a set of programming instructions and standards for accessing a Web-based software application or Web tool.• An API is a software-to-software interface, not a user interface. With APIs, applications talk to each other without any user knowledge or intervention. *from www.howstuffworks.com©2011 Convio, Inc. | Page 6 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    7. 7. No, really. What’s that mean?• Tools that allow applications to communicate with other API Methods applications. Applications,• The “plumbing” used to Database and other Databases connect an interface to a database.• A uniform language understood by web products, based on standards.©2011 Convio, Inc. | Page 7 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    8. 8. Uh, what?• Like the Babel Fish from The Hitchhiker’s Guide to the Galaxy• Like the Universal Translator in Star Trek• Like a USB cable©2011 Convio, Inc. | Page 8 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    9. 9. APIs allow:• Twitter and Flickr posts to show up on Facebook• A “like” button on your website to talk to Facebook• An iPhone app [to do something]• Convio to ask the USPS for the standardized version of a street address• A text message to result in a donation being processed by Convio©2011 Convio, Inc. | Page 9 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    10. 10. ©2011 Convio, Inc. | Page 10 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    11. 11. When Would You Want to Use an API?1. When you want the input form to look different from a standard Convio form©2011 Convio, Inc. | Page 11 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    12. 12. A simple HTML Form calculates the gift amount and moves it to the “other amount” field amount” field©2011 Convio, Inc. | Page 12 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    13. 13. ©2011 Convio, Inc. | Page 13 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    14. 14. Oxfam America©2011 Convio, Inc. | Page 14 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    15. 15. ©2011 Convio, Inc. | Page 15 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    16. 16. ©2011 Convio, Inc. | Page 16 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    17. 17. When Would You Want to Use an API?1. When you want the input form to look different from a standard Convio form2. When you want your users to stay where they are but still take action or donate©2011 Convio, Inc. | Page 17 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    18. 18. PETA forms on Facebook©2011 Convio, Inc. | Page 18 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    19. 19. When Would You Want to Use an API?1. When you want the input form to look different from a standard Convio form2. When you want your users to stay where they are but still take action or donate3. When you want to allow another application to create interactions in Convio Online Marketing©2011 Convio, Inc. | Page 19 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    20. 20. PETA: Action Alerts into txt program©2011 Convio, Inc. | Page 20 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    21. 21. When Would You Want to Use an API?1. When you want the input form to look different from a standard Convio form2. When you want your users to stay where they are but still take action or donate3. When you want to allow another application to create interactions in Convio Online Marketing4. When you want to post data to two places at once©2011 Convio, Inc. | Page 21 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    22. 22. Two-fer©2011 Convio, Inc. | Page 22 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    23. 23. When Would You Want to Use an API?1. When you want the input form to look different from a standard Convio form2. When you want your users to stay where they are but still take action or donate3. When you want to allow another application to create interactions in Convio Online Marketing4. When you want to post data in two places at once5. For other snazzy stuff©2011 Convio, Inc. | Page 23 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    24. 24. Sustainer Upsell• 2 regular Convio Donation forms are used as the backend.• The Renewal form’s submission button initiates a formula to determine the upsell amount.• If a donor selects “Become a Wildlife Guardian,” a custom donation field passes a value to the sustainer form for processing or the “No, thanks” is the Renewal submission©2011 Convio, Inc. | Page 24 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    25. 25. Mobile Clipboard• Go to www.convio.com/vote2012 on your mobile device©2011 Convio, Inc. | Page 25 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    26. 26. Know This Before Taking the API Plunge• APIs are free like puppies are free• You’ll either need to have your technical staff learn and code them or hire someone• When coding APIs for Action Alerts and Donation forms, you’ll need to account for errors in submission and Thank You pages ©2011 Convio, Inc. | Page 26 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    27. 27. Convio Open APIs• Convio Open APIs provide interfaces for integrating Convio content into other websites and creating custom web pages and forms.• All documentation can be found at open.convio.com ©2011 Convio, Inc. | Page 27 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    28. 28. open.convio.com©2011 Convio, Inc. | Page 28 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    29. 29. Downloads©2011 Convio, Inc. | Page 29 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    30. 30. Downloads©2011 Convio, Inc. | Page 30 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    31. 31. Web Services©2011 Convio, Inc. | Page 31 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    32. 32. Free Kits in your DIY Workshop©2011 Convio, Inc. | Page 32 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    33. 33. Open Community©2011 Convio, Inc. | Page 33 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    34. 34. Optional: Stick around for 30 minutes of “how-to-code-an-API”©2011 Convio, Inc. | Page 34 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    35. 35. Getting set up• Are you the site admin or have enough privileges to see Site Options under the Setup menu? You’ve got some work to do with SDPs Whitelisting o IP Addresses and Domains Set up an API Key API Administrative Users©2011 Convio, Inc. | Page 35 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    36. 36. Setup > Site Options > Open API Configuration©2011 Convio, Inc. | Page 36 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    37. 37. Making a Constituent API CallCommon Name Convio Field Name Type Value NotesFirst Name name.first StringLast Name name.last StringEmail primary_email StringGroup Assignment add_group_ids Number 65801Interest Assignment add_interest_ids Number 1234Convio API Method method create required for Convio APIConvio API Key api_key 123p@nd@ required for Convio APIConvio API Version v 1.0 required for Convio APIConvio API Login login_name adminapi required for Convio APIConvio API Password login_password adminapi required for Convio APIConvio API ResponseType response_format xml required for Convio APIConvio API URL https://secure2.convio.net/organization/site/CRConsAPI©2011 Convio, Inc. | Page 37 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    38. 38. Sign Up Form – Convio Required<form name="signup_email" id="signup_email" method="POST" action="https://secure2.convio.net/wwfdev/site/CRConsAPI" ><input type="hidden" name="method" id="method" value="create"><input type="hidden" id="response_format" name="response_format" value="xml"/><input type="hidden" name="v" id="v" value="1.0" /><input type="hidden" id="api_key" name="api_key" value="p@nda123" /><input type="hidden" name="login_name" id="login_name" value=“adminapi" /><input type="hidden" name="login_password" id="login_password" value=“adminapi" />©2011 Convio, Inc. | Page 38 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    39. 39. Convio extras<input type="hidden" name="success_redirect" value=“email_signup_thanks” /><input type="hidden" name="error_redirect" value=email_signup_error” />©2011 Convio, Inc. | Page 39 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    40. 40. Sign Up Form – Your Information<input type="hidden" name="add_interest_ids" id="add_interest_ids" value="1126" /><input type="hidden" name="add_group_ids" id="add_group_ids" value="65801" /><input name="name.first" id="name.first" type="text" value="First Name" maxlength="255" /><input name="name.last" id="name.last" type="text" value="Last Name" maxlength="255" /><input name="primary_email" id="primary_email" type="text" value="Email Address" maxlength="255" />©2011 Convio, Inc. | Page 40 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    41. 41. Handy Links• API Error code list• Open APIs on Community• Open.Convio.com!©2011 Convio, Inc. | Page 41 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    42. 42. Log files!• Convio API Logging Level -- Controls what requests and responses are logged: • OFF (no logging) • ERROR (log only errors) • INFO (log request parameters and responses) • DEBUG (most detailed logging)• For performance reasons, INFO and DEBUG logging are typically used only in development and debugging, whereas ERROR logging or OFF may be used in day-to-day operation. Log file size is limited to a 1MB file with one backup (2MB total log size per site, per JVM), to guard against a potential out-of-memory condition in the event that logging is accidentally left on.©2011 Convio, Inc. | Page 42 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO
    43. 43. Mobile Friendly Donation Form• Download on open.convio.com • Creating a Mobile-Friendly Donations Form with the Convio Donations API.html This HTML document contains step-by-step instructions for setting up your mobile-friendly donation form. • donatenow.txt HTML Code Sample for Mobile-Friendly Donation Form • donatenow_thanks.txt HTML Code Sample for Mobile-Friendly Donation Thank You Page • reus_ismobile.txt Code Sample for detecting mobile devices Try it yourself! Run into trouble? Join the conversation on Community.©2011 Convio, Inc. | Page 43 PROPRIETARY AND CONFIDENTIAL – DO NOT DISTRIBUTE OUTSIDE OF CONVIO

    ×