Skip to content
API Reference/
/
Get download links for a...

Foleon API (1.0.0)

The Foleon API enables you to quickly and easily develop functional applications or integrations. In fact, this is the same API that powers the Foleon platform itself.

The API follows RESTful principles, so if you've worked with a RESTful API before, many of its concepts will be familiar to you. It leverages standard HTTP features, making it compatible with most HTTP clients. Most responses, including errors, are returned in JSON format.

Designed for clarity and ease of use, the API adheres to standard HTTP response codes, providing detailed error messages when necessary.

Download OpenAPI description
index.json
index.yaml
Overview
License
Proprietary
Languages
Servers
EU cluster
https://api.foleon.com/
US cluster
https://api.us.foleon.com/

Authentication

Authenticate your requests using your api credentials by creating a bearer token.

Operations

Docs

All endpoints related to creating, retrieving or deleting Docs (editions), or updating their settings.

Operations

Projects

All endpoints related to Projects (titles).

Operations

Users

All endpoints related to Users.

Operations

Workspaces

All endpoints related to Workspaces (accounts).

Operations

Personalization Categories

All endpoints related to Personalization Categories.

Operations

Personalization Options

All endpoints related to Personalization Options.

Operations

Personalization Properties

All endpoints related to Personalization Properties.

Operations

Personalization Values

All endpoints related to Personalization Values.

Operations

Personalization Tokens

All endpoints related to Personalization Tokens.

Operations

Editing Content

All endpoints related to editing the content of you Foleon Docs.

Operations

Exporting Gzipped Docs

Export tar.gz webpackages to host Foleon Docs on your own server.

Operations

Create a Gzip archive for a Doc

Request

Triggers a new export for a Gzipped Doc. It can take up to 30 minutes for the export to complete.

Security
BearerAuth
Path
doc_idinteger(ResourceIdSchema)required

The resource ID of the Doc

Example: 123456789
curl -i -X POST \
  https://api.foleon.com/magazine/edition/123456789/tar \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Export triggered successfully

Get download links for a Doc's Gzipped archives

Request

Returns all the download links to your Gzipped docs. Get the latest export by sorting on created_on and selecting result["_embedded"]["document"][0]["_links"]["path"]["href"]

Security
BearerAuth
Query
filter[0][field]stringrequired
Value"account"
Example: filter[0][field]=account
filter[0][type]stringrequired
Value"eq"
Example: filter[0][type]=eq
filter[0][value]integer(ResourceIdSchema)required
Example: filter[0][value]=123456789
filter[1][field]stringrequired
Value"properties"
Example: filter[1][field]=properties
filter[1][type]stringrequired
Value"eq"
Example: filter[1][type]=eq
filter[1][value]stringrequired

JSON string with edition filter

Example: filter[1][value]={"edition":"abc123"}
filter[2][field]stringrequired
Value"filetype"
Example: filter[2][field]=filetype
filter[2][type]stringrequired
Value"eq"
Example: filter[2][type]=eq
filter[2][value]stringrequired
Example: filter[2][value]=application/gzip
order-by[0][type]string(OrderByTypeParameterSchema)

a fixed value

Value"field"
order-by[0][field]string(OrderByFieldParameterSchema)

The field to sort by

Example: order-by[0][field]=created_on
order-by[0][direction]string(OrderByDirectionParameterSchema)

Descending or ascending.

Enum"desc""asc"
curl -i -X GET \
  'https://api.foleon.com/v2/document?filter%5B0%5D%5Bfield%5D=account&filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bvalue%5D=123456789&filter%5B1%5D%5Bfield%5D=properties&filter%5B1%5D%5Btype%5D=eq&filter%5B1%5D%5Bvalue%5D={%22edition%22%3A%22abc123%22}&filter%5B2%5D%5Bfield%5D=filetype&filter%5B2%5D%5Btype%5D=eq&filter%5B2%5D%5Bvalue%5D=application%2Fgzip&order-by%5B0%5D%5Btype%5D=field&order-by%5B0%5D%5Bfield%5D=created_on&order-by%5B0%5D%5Bdirection%5D=desc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

JSON response for a list of Download links for Gzipped Docs.

Bodyapplication/json
_linksobject
page_countinteger
page_sizeinteger
total_itemsinteger
pageinteger
countinteger
totalinteger
_embeddedobject
Response
application/json
{
  "_links": {
    "self": { … },
    "first": { … },
    "last": { … }
  },
  "page_count": 0,
  "page_size": 0,
  "total_items": 0,
  "page": 0,
  "count": 0,
  "total": 0,
  "_embedded": {
    "document": [ … ]
  }
}

Foleon Analytics

All endpoints related to Foleons native analytics.

Operations

Media Library

All endpoints related to managing media in Foleon's media library.

Operations
Copyright © Foleon B.V. All rights reserved.