Getting Started

The DoorFlow API is organised around REST. Our API has predictable resource-oriented URLs, accepts form-encoded or JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication is through OAuth 2.0.

Getting your OAuth 2.0 credentials

OK, first things first... let's get your application's OAuth 2.0 credentials.

When your application is in 'Testing' mode you'll be provided with a sandboxed test account on DoorFlow.com. This is the only DoorFlow account that you can link to an application in 'Testing' state.

Using the Demos on developer.doorflow.com

While your application is in 'Testing' mode you will have access to Demos in your application section of developer.doorflow.com. These demos will show you the complete request/responses required to perform some common jobs. The demos use your client credentials so the request/responses are exactly the same as you'd see yourself when developing your application.

Unsure about OAuth or how to use the DoorFlow API? Using the demos in a matter of minutes you'll be authenticate with OAuth and have issued a mobile pass. Superfast!


Using Postman

Postman is an excellent tool for interacting with APIs.

You can use Postman to run the API by forking into your own workspace. From there you can use your own authorization and call the production API from within Postman.

Making requests with Postman is easy. On the right-hand side of the app, you'll see a panel from where you can create a request.

We want to make a request to the "People" endpoint, which is the same one we accessed in the browser example above. So, into the field that says "Enter request URL", type (or paste) the URL

http://admin.doorflow.com/api/3/people.json

We want to retrieve information, so a GET request is the proper method. If the dropdown box next to the URL says anything other than GET, please change it.

Clicking "Send" again will return a full list of the people you have permission to see, in JSON format.