REST API Overview - dfryan/dreamfactory GitHub Wiki
The DreamFactory REST API is a RESTful implementation of our interface allowing access to the native services available on every DSP, as well as, other remote web services that you make available on your DSP.
A very cool tool to help you with our REST API is the Live API module included in the Admin Console of every DSP. More information on using Live API can be found here.
The format of the typical DreamFactory REST API calls can best be described as follows...
<rest-verb> http[s]://<dsp-server-name>/rest/[<service-api-name>]/[<resource-path>][?<param-name>=<param-value>]
with the following breakdown for each part...
- rest-verb - The typical REST HTTP verbs like GET, POST, PUT, DELETE. We have also added support for PATCH or MERGE. In certain services, HEAD and OPTIONS verbs may be supported as well.
- dsp-server-name - Our hosted DSP name, localhost, your specific server name or IP, etc.
- rest - This is static name for accessing the REST API. Performing a GET here returns an array of available services.
- service-api-name - The API name (api_name - different than the name used for listing in the admin console) of the service you want to access. Performing a GET here on most of the native services will return an array of available resources.
- resource-path - The optional resource of the service. This path may include multiple sections divided by '/'.
- param-name and param-value - See Common Headers and Parameters or each specific service type for allowed URL parameters for each REST call.
The REST API documentation consists of the following sections. Check out the Common Headers and Parameters section and the Authentication section before digging into the other sections.