Skip to content

Commit

Permalink
Add explanatory text on Open 311
Browse files Browse the repository at this point in the history
  • Loading branch information
tomschenkjr committed Aug 12, 2017
1 parent f9e38be commit 973379c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Open311 API Documentation

Chicago's [311 system](https://www.cityofchicago.org/311) gives residents a central phone number and location to request city services, report non-emergency issues, and get updates on city work. Open311 provides greater access and transparency since it allows developers to build apps and websites on top of Chicago's 311 system. Open311 is a REST-based Application Programmer Inferface (API) that lets developers requests directly to 311 and also retrieve status on existing service requests.

## Authentication

You may need an API Key in order to call some endpoints in Chicago's Open311 system. This is indicated in the documentation by a field labeled **"Requires API Key?"**.
Expand All @@ -23,7 +25,7 @@ Visit the above URL to request an API key from the test Open311 system. Your req
### Production
[Request production API key](http:https://311api.cityofchicago.org/open311/v2/apps/new) may be requested after successfully using a test API key.

!!! tip
!!! attention
All requests for API keys must first be tested in the development environment.
Use the same application name as used with the test key to ensure quick turn-around
for your request. When testing, ensure that your application can successfully write
Expand Down

0 comments on commit 973379c

Please sign in to comment.