My favorites | Sign in
Project Home Wiki Issues
Search
for
FAQ  
Frequently Asked Questions (FAQ)
Updated Sep 8, 2009 by jmorin...@gmail.com

<- Back to Main Page


Frequently Asked Questions

What can I do with the API?

The Tweetvite API is currently read only and does not require any type of authentication. In the future, we'll be adding authentication which will allow us to add write methods and expand the number of read methods to include protected data.

Are there limits on how often I can query the API?

There aren't any strict limits that say how many requests you can make per hour. However, all requests are logged and if we feel someone is abusing their access privileges, their IP will be blacklisted.

How long can I store Tweetvite data?

Some Tweetvite data originates from Facebook which does not allow its data to be stored for more than 24 hours. To comply with this, we refresh our users' Facebook profiles every day, so you must as well. This applies to any "User Profile" data with a service_type of 2.

Also, keep in mind that things are constantly changing on Tweetvite, so you should be refreshing any stored data as often as is reasonable (but not more often!). Event descriptions are updated, people change their RSVP, locations may change, etc. so make sure that you're not presenting stale data that would confuse or mislead anyone. Also, if an event is canceled, you must indicate that it is canceled. If an event is deleted, it must also be removed from your application.

For more information on what is acceptable and what is not, please see the API Usage Policies and Guidelines.

How do I report bugs and request features?

All API related bug and feature requests should be reported using our issue tracker. Before reporting anything, please do a quick search and make sure that your issue has not been reported already. If it has, please just star and add a comment to the existing one.

I'm having trouble with status codes in Flash and Javascript

By default, all API responses include an informative http status code that indicates the type of response. For example, if you have a request using an invalid public event id, the response will include a 404 http status code indicating that the resource could not be found. This doesn't always work well for Flash and Javascript, so adding the parameter suppress_response_codes=1 to any request will cause it to always return a 200 success code.

What do the HTTP Status Codes mean?

By default, all API responses include an informative http status code that indicates the type of response. See the previous question for a way to override this behavior.

  • 200 OK: The request was processed successfully.
  • 400 Bad Request: The request was invalid. You probably forgot a required parameter.
  • 403 Forbidden: The request was valid, but we are refusing to fulfill it because the calling user does not have access to the data.
  • 404 Not Found: The resource your requested does not exist.
  • 500 Internal Server Error: There is an error that won't resolve itself. Please contact the Tweetvite team.
  • 503 Service Unavailable: Tweetvite is either swamped with requests or is unavailable because of maintenance.

If an error has occurred, an error message will be included in the response. Please note that the text in these messages may change and should not be relied upon for anything other than being a human readable indication of the error.

Response Formats

The Tweetvite API allows for three response formats: json, xml, and serialize. JSON is the default format if a response format is not specified. The serialize form is created using the php serialize function. You can specify the format by adding it as a parameter to the http request (method_name?format=xml).


<- Back to Main Page

  1. Getting Started - API Overview
  2. Tweetvite API Documentation
  3. Frequently Asked Questions (FAQ)
  4. Policies and Guidelines
  5. Resources

Sign in to add a comment
Powered by Google Project Hosting