FloPlan API - Authentication

All developers will be issued non-expiring OAuth 2 access tokens that may be used to access the FloPlan API directly. All requests using such a token must be made using HTTPS.

Important!

Never provide your access_token to a web browser or other end-user agent. Instead, maintain a separate session and persist this data in a location accessible only by your application (e.g. do not store the access_token in a cookie). Contact api-support@floplan.io for further guidance.

To request data from the api you will need to provide two headers. The Authorization header and the Accept header. You will typically want an Accept header of application/json but, if you are accessing a RESO metadata document you will need to use application/xml. For the Authorization header you will use Bearer <your_access_token>.

Example /$metadata Retrieval Headers
Authorization: Bearer <your_access_token>
Accept: application/xml
Example /Media Retrieval Headers
Authorization: Bearer <your_access_token>
Accept: application/json

Here is a sample curl command line request demonstrating proper authentication syntax. Note that you may need to encode the URL to ensure that curl properly parses this request. Headers do not need to be URL encoded. See example request documentation for details.

curl "https://api.floplan.io/Reso/Media?$filter=OriginatingSystemResourceRecordKey eq 'LISTINGKEY_HERE' and OriginatingSystemResourceRecordSystemID eq 'RESO_OUID_HERE'" -H "Authorization: Bearer your_access_token" -H "Accept: application/json"