Fast.io Developer Documentation

Fast.io simplifies the delivery of sales and marketing materials - documents, PDFs, images, videos, and websites. If you're already storing your documents in the cloud, no changes are required, and there's no need for an IT department.

Get Started    Fundamentals

Resource Format

Standard URI options

Limit and Offset

Any resources that returns variable length datasets support using the limit operand on the URI. Individual API’s may also implement the offset verb to get additional results of a dataset after the initial request. An example using both offset and limit is below.

$ curl -X GET https://go.fast.io/api/v1.0/logs/MyServer.imfast.io?start=2015-11-05&offset=100&limit=100 \
    -H "Authorization: yffaenajzny66mrdiuk6s6dvk6ef2gq7ia72"
Sort and Dir

Any resources that return datasets may be sortable by specifying either or both sort and dir in the URI signifying the sort field and the sort direction respectively. This is available on a case by case basis, so refer to an individual API.

Resource Endpoints

Below is a list of notable endpoints for API implementation.

API Endpoints

Format

The format for API requests is https://go.fast.io/api/:{version}/:{resource}

🚧

Case Sensative

URI's and query strings are case sensitive, subdomains and Server names are not.

Versioning

You can use three different formats for the API version, an exact version, such as v1.0, the current version of a major branch, such as v1.x, or the latest version which is always current.

❗️

Choosing the API Version Format

If you use the current branch, your application may break when updates are rolled out which may include major releases. The safest format to use is v1.x where the major version is fixed and the minor version is the latest.

📘

Minor Version Changes

When minor versions of an API change, they are only for bug, security, and scalability adjustments. Resources and resource format will never change once a major version reaches General Availability status.

CDN Endpoints

Both HTTP and HTTPs (secure via TLS) transfers are supported in CDN URLs. CDN URL’s are case sensitive and support a number of standard HTTP features, including byte-range, if-modified-since, and if-none-match requests.

CDN URL's are comprised of the Server name as the CDN subdomain. An example Server URL is https://demoserver.imfast.io/.

This format is designed to visibly identify you and the full path of the file, an example is below.

https://{name}.{domain}/{path}/{file name}

Updated about a year ago

Resource Format


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.