FormLizard API
Welcome to the FormLizard API. Using this API, you will be able to integrate the form completing and document authoring power of FormLizard into your own applications. This API is a REST (Representational State Transfer) API that allows access to the interviews and interview sessions in a FormLizard account without separately logging into FormLizard every time. To get started, you need developer keys.
API Keys
You'll need two separate API Keys to use the FormLizard API. The first one you'll need is a Developer's Key which you can sign up for here.
The second one is a User Key associated with an existing FormLizard Account. Your User Key can be found in Your Account -> Manage Integrations. You can also reset User Key from the same location. If you reset your key code you will have to update any programs that use the old code to authenticate.
Your API key is what will give you outside access to your FormLizard account. Instead of logging in using your normal password, your code will use the Developer Key and User Key to authenticate.
Authentication
The FormLizard API uses basic http authentication. Requests should be sent with DeveloperKey:UserKey as the username/password.
Example using cURL:
curl -u xxxx1234-1234-xxxx-1234-xxx123xxx456:xxxx1234-1234-xxxx-1234-xxx123xxx456 https://example.formlizard.com/api/1.0/interviews
Conventions Used in API Documentation
Any text that needs to be replaced with your own information will be encased in curly brackets {like this}.
Retrieving Data Using the API
The way to get data from your FormLizard account using the API is with an HTTP GET. This can be used to return a number of results or a single item. Responses can be retrieved in either XML or JSON. To receive a response in either XML or JSON, simply set your Accept header to 'application/XML' or 'application/json' respectively. The default response type is JSON.
Writing Data Using the API
Writing data with the API is a cinch. To create new information, use the HTTP POST verb. If you want to edit or update something that already exists, use the PUT verb. If there is something that you just don't want any more, use the DELETE verb. When you PUT or POST to the FormLizard API you can use either XML or JSON. To tell the server you are sending data in either XML or JSON, simply set your Content-type header to 'application/XML' or 'application/json' respectively. By default, the API will expect JSON data.
API Limit
Clients may request up to 6,000 API calls every 24 hours. Going over the limit will result in an error. If you need more than this, send us a support ticket.
Example Code
We've assembled some test code to help get you started in your developing. Have a look at our PHP Examples.
Errors
The FormLizard API returns a standard set of errors when a problem occurs.
| Response Code | Meaning | What To Do |
|---|---|---|
| 400 | Bad Request | You have left out a required parameter or one of the optional sorting parameters was incorrect. |
| 401 | Unauthorized | Either the developer or user API key was incorrect. |
| 404 | Not Found | The resource requested could not be located. |
| 409 | Conflict | Most often this error throws when you are trying to request a completed Form for an interview that doesn’t have an Answer for all required Fields or if you try to create a new Answer for a Field that already exists. |
| 500 | Internal Server Error | If your call is properly formatted and returns a server error, the server may be down for maintenance. Try your call again at a later time. |
| 503 | Service Unavailable | You have exceeded your maximum number of calls allowed in a 24 hour period. |
Private and secure for the most rigorous uses
