Performing API Calls

Performing calls

The API end point, where all calls must be directed, is: Although not required, it is highly recommended sending requests over HTTPS due to the nature of the information and the fact that the API key will be sent in plaintext otherwise.

The following HTTP requests are allowed:

  • PUT: Update resource
  • POST: Create resource
  • GET: Get a resource or list of resources
  • DELETE: To delete resource

The API provides JSON interface for the components shown in the navigation menu. This will expand over time as more functionality is added to the service

Usual Server Responses

When sending a request to a File Request Pro endpoint, you may receive the following response code:

  • 200 OK: the request was successful (some API calls may return 201 instead).
  • 204 No Content: the request was successful, but there is no representation to return (i.e. the response is empty).
  • 400 Bad Request: the request could not be understood or was missing required parameters.
  • 401 Unauthorized: authentication failed or user doesn't have permissions for requested operation.
  • 403 Forbidden: access denied.
  • 404 Not Found: resource was not found.405 Method Not Allowed : requested method is not supported for resource.

Error Handling

Errors responses will return a non-200 status code and a JSON err message and error code.

Rate Limiting

The API is rate limited per API token. You will receive a 429 HTTP status code if you exceed the rate limit. The rate limit is 50 requests per minute per token and is subject to change.