Skip to content
/Authentication

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

Obtain an OAuth token

Request

Bodyapplication/jsonrequired

Request payload for obtaining an OAuth token.

grant_typestring

The grant_type will always be "client_credentials"

Value"client_credentials"
client_idstring

Your API key

Example: "xxxxx000x0"
client_secretstring

Your API secret

Example: "X0xXx0X0xxX0XxXx0X0Xxx0xXx0xX0Xx0XxX0xX0xxX0XxXx0X0Xxx0xXx0xX0"
curl -i -X POST \
  https://api.foleon.com/oauth \
  -H 'Content-Type: application/json' \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "xxxxx000x0",
    "client_secret": "X0xXx0X0xxX0XxXx0X0Xxx0xXx0xX0Xx0XxX0xX0xxX0XxXx0X0Xxx0xXx0xX0"
  }'

Responses

JSON response for an Oauth token

Bodyapplication/json
access_tokenstring
Example: "x0xx00x00xxx00x00x0xxx000000000000x000xx"
expires_ininteger
Example: 3600
token_typestring
Example: "Bearer"
scopestring or null
Example: null
Response
application/json
{
  "access_token": "x0xx00x00xxx00x00x0xxx000000000000x000xx",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": null
}

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

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.