View
 

Recommended Practices

Page history last edited by James 2 years, 7 months ago

Recommended Practices 

 

These are some tips/tricks that we suggest that you make use of while developing against our API.  

  • When deploying, request the specific version of our API that you developed against.  See Versioning
  • Access our API via HTTPS.  We currently do not force the usage of HTTPS, but we will in the future.  The reason for using HTTPS is that we utilize basic authentication for security.  If you use normal HTTP, this means that your Filtrbox credentals are passed in what amounts to plain text.  All you have to do to access our API via HTTPS is to simply change the URL you are requesting to https://<requestedurl>
  • To browse the API in a readable fashion, append a format query parameter to the end of the resource you are requesting.  For example: https://filtrbox.com/rest/folders?format=json.  Currently, we only support 'pretty printed' json, but XML will be supported very soon.  

Comments (0)

You don't have permission to comment on this page.