Data transfer

All entities sent and received in the API are encoded using JSON objects.

The FM RESTful API is compliant with the W3C CORS specification, which allows any properly-authorized requests to be made from any origin domain. This means that you should not need to wrap calls in JSONP callbacks in order to make calls from browser-based applications.

In order to save bandwidth, the endpoint supports gzip and zlib compression, to enable this, you can send the Accept-Encoding: gzip, deflate header in the request.

It is not mandatory but, it’s recommended that you setup the request headers Accept and Content-Type toapplication/json.

When transmitting information on the URL, for example, when performing  a queriy, it’s mandatory to URL encode the query. This is a standard format defined in the RFC 3986 and almost any library capable of performing HTTP requests should support this feature. For example:

The url: https://restfm.forcemanager.net/api/companies?q=address_1=’L Hospitalet’

Becomes: https://restfm.forcemanager.net/api/companies?q=address_1%3D’L%20Hospitalet’ 

IMPORTANT: All the examples presented in this document are shown with the un-encoded version

Was this article helpful?
Sign up to give your opinion about our articles.