API Overview

The SeeClickFIx API gives developers the power to extend SeeClickFix's core functions. SeeClickFix supports the open311 initiative and provides a separate API at http://seeclickfix.com/open311.

Please email team@seeclickfix.com for feedback.

Authentication

SeeClickFix uses key based authentication. You can obtain or change your key in your personal preferences page. This key should remain secret and should only be used over SSL for security. Unless noted otherwise, read-only requests do not require a key. Write requests require a key.

https://seeclickfix.com/api/issues/index.xml?api_key=1asasdfrtwerbw...

Getting a Key

To obtain a key you must have a SeeClickFix account. You may register for a free account here: https://seeclickfix.com/register

Once you have an account login and go to "My Account" > "Preferences". There is an "API Keys" section on the lefthand side of the page. Once you generate a key its ready to use. Please remember that use of the API falls under our Open Data Policy (http://seeclickfix.com/open_data) and Terms of Use (http://seeclickfix.com/terms_of_use).

URLs

URLs follow the general format:

https://[locale].seeclickfix.com/api/[major_version].[minor_version]/[resource].[format]?api_key=...

API Development Mode

A development service is running at http://seeclicktest.com. All data is refreshed there nightly.

Versions

API versions can be specified in the following ways. The latest version is 0.1.

This URL explicitly declares the major and minor version number:

... seeclickfix.com/api/[major_version].[minor_version]/...

This URL declares the major version number. The minor version will be the latest release.

...seeclickfix.com/api/[major_version]/...

This URL assumes the latest major and minor release.

...seeclickfix.com/api/...

Locale

All attributes are consistent between locales. Errors may be translated based on the given locale. Objects created will record the locale they were created in and notices based on these objects will be delivered with the proper locale. i.e. if an issue is created with the "es" locale, all email to the creator will be delivered with Spanish translations.

Resources

Issues

• List Issues
• Issue Details
• Create an Issue

Comments

• List Comments and Issue History
• Create a Comment

Watch Areas

• List Watch Areas in a given location.

Service Request Types

• List Service Request Types

Service Request Questions

• List questions for a single service request type.

Data License

SeeClickFix data sources, including XML, RSS, KML and JSON, are licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 United States License. Attribution should be to seeclickfix.com.

Persons or organizations wishing to reuse large portions (ie., more than occasional queries ) of data are required to contact us first at team@seeclickfix.com. We are very interested in working with researchers and/or agencies to ensure that this data is put to good use!

http://www.seeclickfix.com/open_data

Change Log

We are currently preparing for a 0.1 release. All changes to the API will be listed here. If you're experiencing bugs please contact team@seeclickfix.com.

Reference Implementations

We will be releasing a reference implementation shortly after the API is finalized.

HTTP Headers

The following header types are important to include.

Accept - Our API respects the accept header. The following content types will return data in the respective format: "Content-Type: application/xml", "Content-Type: application/json".

Content-Type - The mime type of the body of the request (used with POST and PUT requests). The determines the parsing method by our application servers. The most common type is application/x-www-form-urlencoded, but we also support xml and json, which can be specified as in the Accept.

Feedback

SeeClickFix is actively developing the API based on user feedback. We'd love to hear from you. Please email us at development@seeclickfix.com.