Prior to beginning work on an Austin Open311 project, you will need to create your developer profile and obtain a Test API Key. This will allow you to test service requests (SR) in your Austin Open311enabled app solution and is the first step toward receiving a Production API Key.
Once you have successfully integrated your application in the test environment, you can apply for a Production API Key. After you have successfully completed the final testing process, your Production API Key will be activated giving you access and publishing privileges in the Production environment.
There are 2 developer environments:
- Test API Key - Allows you to test your app’s SRs in a test environment.
- Production API Key - Allows you to publish SRs in the production environment
The procedures to attain these credentials are described below. Please follow these steps:
Test API Key Request
To request your Test API Key, create your user profile at the Developer Resources.
Important: SRs submitted by your mobile device are restricted to the same jurisdictional areas as Austin 3-1-1. For information on serviceable areas see the Jurisdictions Web Map. Yellow areas are the minimal areas serviced and change periodically. For exact addresses serviced most use the Address Search.
After you have submitted the required information a Test API Key will automatically be sent to you via the email address you provided. (It will also be available on the confirmation page). You can immediately get started developing in the Open311 test environment.
Production API Key Activation
When testing is completed you may request a Production API Key at the Developer Resources.
Download and complete the API DevForm from here: API Dev Form. Submit test SRs using the predefined data for each SR type that you plan to use. Record the SR number for each SR created in the space provided and return the form to Open311developers@austintexas.gov.
Note: The API DevForm is subject to change periodically as SRs change, are added or deleted. To help ensure your tests are valid, ensure that you are using the most updated API DevForm and complete your tests promptly. If there is any question, feel free to contact our support team at Open311developers@austintexas.gov.
API DevForm Completion
Step 5 (API DevForm Developer Profile Tab):
Complete the requested profile information. Note: Some fields are text entry while others require that you select from options.
Step 6 (API DevForm Developer Profile Tab):
Select all SR Types and functions that you plan to use in your app.
The API DevForm includes 17 test worksheets corresponding to each available SR Type that you wish to test and make live.
After choosing your SR tests from the API DevForm, create and submit SRs using your application. You must include the predefined information that is included in the TEST column.
If the SR requires a text entry for the answer, enter the predefined text answer exactly as it appears in the DevForm to prevent test failures. A single failure will require a completely new series of tests. Record the SR number for each SR created in the space provided and return the form to Open311developers@austintexas.gov.
Please allow 10 business days for your SR tests results to be evaluated for compatibility within our Open311 system. Upon determining positive results you will then receive an email notice that your Production API Key has been activated and you can begin submitting service requests in our Open311 Production environment.
IMPORTANT: Your API Key has been registered to work with only the SR type(s) that you have tested and been approved to use. If you wish to add new SR types to your application contact us for additional testing plans.
For your protection unauthorized SR types submitted through your API key may result in key termination.
Please add email address Open311developers@austintexas.gov to your Address Book/safe senders list to ensure that you continue to receive notifications.