Home → Using FormSpring → iPhone App → Setting Up Your API Key

8.2. Setting Up Your API Key

To use our iPhone App, you will need to set up at least one FormSpring API Key.  You can do this by logging into FormSpring.com and clicking on "Account Settings" and then "API".



Next, click on "Create an API key" and fill in your API Key Description. 



After that, you will want to set the Access options for your key, either giving access to "All Forms and Fields" or "Selected Forms and Fields".  If you only want to give access to selected forms and fields, make sure that when you check the name of each form you want to give access to, that you also check either the box for "All Fields" or the boxes of the specific fields for that form that you'd like to share.  Be sure not to forget to share fields or no data will show on your iPhone.

Finally, you need to set the Permissions for your API Key.  You can give access to info only (view form information and statistics), Data (search and view submitted data), Submit (submit new entries but not view or edit data), or Write access (modify submitted data and submit new entries).  If you just want users to be able to see your data from the iPhone, you probably want to use the Data permission.  If you want them to be able to submit forms from the iPhone but not view data, you will want to use the Submit permission.  If you want to give full access to both read and submit data, use the Write permission.

E-Mail Your API Key

You can type in your API key manually if you want, but that's a pain.  One cool feature at FormSpring is that you can e-mail your API key to your iPhone, and then click on a link in the e-mail you receive to automatically send your key to the FormSpring app.  This should save you around five minutes of typing and help you avoid typos.