Convio JavaScript API Library (ConvioApi.js and api_client.html) files

Options
Corey Pudhorodsky
Corey Pudhorodsky
Ancient Membership 10 Comments Facilitator Level 3 Inquirer Level 2
in Blackbaud Luminate Online® & Blackbaud TeamRaiser® Discussions

Several questions have come up from clients in relation to the location and generation of the ConvioApi.js and api_client.html files that must be referenced to use the JavaScript API library: These file will always be located in the api/ directory of an organization's site instance. Generally that will be something like:

http://SHORTNAME.convio.net/api/ConvioAPI.js

Where SHORTNAME is the abbreviation for your site instance. You can also use the primary site domain that points to your site using the S29 STag.

The files are (re)generated whenever a change is made to the Open configuration settings. If the files are missing, create or change the API key settings for your site instance. The files should automatically be refreshed at that time.

Tagged:

Comments

  • Michael
    Michael
    Ancient Membership 100 Comments Facilitator Level 3 Inquirer Level 2

    The filename is "ConvioApi.js" --> Convio, being an Apache server, is CasE SensiTive...

    http://SHORTNAME.convio.net/api/ConvioApi.js

    I'm a little unclear on the purpose of this library... is it a simple helper script for using APIs? What does it provide that, say, jQuery or Prototype.js doesn't (for those of us who are fluent in scripting under those frameworks, at least)? Is there any particular advantage to the Convio library?

    Also, for reference, here's the documentation:

    http://SHORTNAME.convio.net/api/ConvioApiClient.html

  • Jeff Mills
    Jeff Mills
    Ancient Membership 10 Comments Facilitator Level 3
    Michael :

    The filename is "ConvioApi.js" --> Convio, being an Apache server, is CasE SensiTive...

    http://SHORTNAME.convio.net/api/ConvioApi.js

    I'm a little unclear on the purpose of this library... is it a simple helper script for using APIs? What does it provide that, say, jQuery or Prototype.js doesn't (for those of us who are fluent in scripting under those frameworks, at least)? Is there any particular advantage to the Convio library?

    Also, for reference, here's the documentation:

    http://SHORTNAME.convio.net/api/ConvioApiClient.html

    It isn't solely a conveniency helper, though for people who are not fluent in other AJAX libraries it may be valuable as such. It is also part of the cross-domain scripting solution for Convio APIs so that you can use AJAX with Convio APIs in pages served from a different domain. You can read more about this in Dave Hart's . The discussion of cross-domain issues begins on slide 43; the specific technique of using hidden iframes begins on slide 56.

  • Ryan Hagg
    Ryan Hagg
    Ancient Membership 10 Comments Facilitator Level 2
    Michael :

    The filename is "ConvioApi.js" --> Convio, being an Apache server, is CasE SensiTive...

    http://SHORTNAME.convio.net/api/ConvioApi.js

    I'm a little unclear on the purpose of this library... is it a simple helper script for using APIs? What does it provide that, say, jQuery or Prototype.js doesn't (for those of us who are fluent in scripting under those frameworks, at least)? Is there any particular advantage to the Convio library?

    Also, for reference, here's the documentation:

    http://SHORTNAME.convio.net/api/ConvioApiClient.html

    The href for your ConvioApi.js link goes to ConvioAPI.js and as previous advertised convio is on an Apache server so it is CasE SensiTive

Categories