nitro-openapi.flyo.cloud Open in urlscan Pro
2606:4700:20::ac43:44ab  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Config
   * getGet Config
 * Version
   * getGet Version Information
 * Sitemap
   * getGet Sitemap
 * Search
   * getGet Search by query
 * Pages
   * getGet Home
   * getGet Page by slug
 * Entities
   * getFind entity by uniqueid
   * getFind entity by slug and optional Entity-Type-ID

API docs by Redocly





FLYO NITRO (1.0.0-BETA.200)

Download OpenAPI specification:Download

Terms of Service


This document provides a comprehensive overview of all the endpoints available
for Flyo Nitro, a powerful platform designed to facilitate the development of
websites. Flyo Nitro is built upon three strategic pillars that play a central
role in website development:

 * Config: The config component is responsible for loading all the necessary
   elements required for seamless navigation within the website layout. This
   includes crucial elements like the navigation menu or global content, such as
   the "Locations" section of an entity, which can be utilized in the footer
   across all pages.
 * Pages: Pages are evaluated based on their unique slug (path) and encompass
   all the content needed to populate a specific page. This includes various
   content elements, known as blocks, as well as meta information like
   "og-descriptions." Additionally, pages can dynamically incorporate content
   from entities by employing mapping techniques.
 * Entity: Entities can be retrieved by utilizing a unique identifier, which can
   be configured within Flyo Nitro. Each entity provides comprehensive details
   in the form of fields, offering specific content tailored to a particular
   context.

Furthermore, it is important to distinguish between the development and
production environments in Flyo Nitro. In the development environment, any
changes made to data within the Flyo User Interface are immediately accessible,
even without saving. This feature enables users to have a live preview of the
changes during data entry. On the other hand, the production environment
exclusively utilizes saved data, ensuring that only finalized content is
displayed.

For more detailed documentation in German, please visit: dev.flyo.cloud

Flyo Developer-Ressourcen


CONFIG


GET CONFIG

The config API endpoint provides comprehensive information required for
configuring the layout of websites. It encompasses various essential elements,
including containers with pages, an extensive list of available slugs, globals
containing content pool data, and crucial details about the Nitro configuration
itself. By accessing this endpoint, developers can gather all the necessary data
to effectively design and structure their websites. The endpoint offers a
holistic view of the website's layout, empowering developers to tailor the user
experience and optimize the overall design.

AUTHORIZATIONS:

ApiToken

QUERY PARAMETERS

lang
string
Example: lang=de

The language context for the current request. If not defined, the defed primary
language will be used. If the nitro setup is not configured as multi lingual,
the language parameter won't have any effect


RESPONSES

200

OK

get/config

Production Server

https://api.flyo.cloud/nitro/{version}/config


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "nitro": {
    * "domain": "flyo.ch",
    * "slug": "flyo-ch",
    * "version": 156,
    * "updated_at": "123456789",
    * "language": "de",
    * "primary_language": "de"
   
   },
 * "pages": [
    * "foo",
    * "bar",
    * "foo/quix"
   
   ],
 * "containers": {
    * "footer": {
       * "uid": "e4244ff7-e20e-40b9-b6a1-1117206aca14",
       * "identifier": "footer",
       * "label": "Footer",
       * "items": [
          * {
             * "type": "page",
             * "target": "_self",
             * "label": "Contact Us",
             * "href": "/contact-us",
             * "slug": "contact-us",
             * "properties": {
                * "color": "red"
               
               },
             * "children": [ ]
            
            }
         
         ]
      
      }
   
   },
 * "globals": {
    * "locations": [
       * {
          * "field1": "Location Name #1",
          * "field2": "location-slug"
         
         }
      
      ]
   
   }

}


VERSION


GET VERSION INFORMATION

The Version API endpoint offers a highly efficient solution for evaluating the
current caching status of your application's caching mechanism. This
functionality allows you to cache the entire application configuration and page
responses indefinitely. However, utilizing this endpoint enables you to assess
the validity of the cache by sending a request to determine its current status.
This caching endpoint is specifically designed for optimal performance when
compared to the configuration endpoint, which requires more thorough evaluation
and encompasses a substantial response body.

AUTHORIZATIONS:

ApiToken

QUERY PARAMETERS

lang
string
Example: lang=de

The language context for the current request. If not defined, the defed primary
language will be used. If the nitro setup is not configured as multi lingual,
the language parameter won't have any effect


RESPONSES

200

OK

get/version

Production Server

https://api.flyo.cloud/nitro/{version}/version


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "version": 156,
 * "updated_at": "123456789"

}


SITEMAP


GET SITEMAP

This endpoint provides comprehensive data for generating the sitemap. It
encompasses all the necessary information, including pages from containers, as
well as all entities that have been mapped.

AUTHORIZATIONS:

ApiToken

QUERY PARAMETERS

lang
string
Example: lang=de

The language context for the current request. If not defined, the defed primary
language will be used. If the nitro setup is not configured as multi lingual,
the language parameter won't have any effect


RESPONSES

200

OK

get/sitemap

Production Server

https://api.flyo.cloud/nitro/{version}/sitemap


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
[
 * {
    * "entity_unique_id": "2348uc",
    * "entity_title": "News Title #1",
    * "entity_teaser": "The quick brown fox jumps over the lazy dog",
    * "entity_slug": "news-title-1",
    * "entity_time_start": 12345678,
    * "entity_type": "schema",
    * "entity_type_id": 132,
    * "entity_image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg",
    * "routes": {
       * "detail": "view/<uniqueid>/<slug>"
      
      }
   
   }

]


SEARCH


GET SEARCH BY QUERY

This endpoint offers a powerful capability to search through the websites
sitemap, encompassing both pages and entities. With this endpoint, users can
efficiently explore and retrieve information from your sitemap by creating a
paginated search experience.

AUTHORIZATIONS:

ApiToken

QUERY PARAMETERS

query
required
string
Example: query=foobar

The query keyword that needs to be looked up. It is important to ensure that the
query is properly URL encoded for accurate processing and retrieval.

lang
string
Example: lang=de

The language context for the current request. If not defined, the defed primary
language will be used. If the nitro setup is not configured as multi lingual,
the language parameter won't have any effect


RESPONSES

200

OK

get/search

Production Server

https://api.flyo.cloud/nitro/{version}/search


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
[
 * {
    * "entity_unique_id": "2348uc",
    * "entity_title": "News Title #1",
    * "entity_teaser": "The quick brown fox jumps over the lazy dog",
    * "entity_slug": "news-title-1",
    * "entity_time_start": 12345678,
    * "entity_type": "schema",
    * "entity_type_id": 132,
    * "entity_image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg",
    * "routes": {
       * "detail": "view/<uniqueid>/<slug>"
      
      }
   
   }

]


PAGES


GET HOME

This endpoint allows you to retrieve the designated homepage of a website.
Alternatively, you can utilize the pages endpoint by specifying an empty slug
parameter to achieve the same result. By using either of these methods, you can
effectively access the desired homepage of the website.

AUTHORIZATIONS:

ApiToken

QUERY PARAMETERS

lang
string
Example: lang=de

The language context for the current request. If not defined, the defed primary
language will be used. If the nitro setup is not configured as multi lingual,
the language parameter won't have any effect


RESPONSES

200

OK

get/pages/home

Production Server

https://api.flyo.cloud/nitro/{version}/pages/home


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "id": 123,
 * "title": "About Me",
 * "href": "/about-me",
 * "slug": "about-me",
 * "json": [
    * {
       * "items": [
          * {
             * "title": "Hello",
             * "teaser": "Great!"
            
            },
          * {
             * "title": "Hallo",
             * "teaser": "Toll!"
            
            }
         
         ],
       * "content": {
          * "title": "Hello World"
         
         },
       * "config": {
          * "is_dark": true
         
         },
       * "identifier": "hero_image",
       * "uid": "e4244ff7-e20e-40b9-b6a1-1117206aca14",
       * "component": "HeroImage",
       * "slots": {
          * "slot1": {
             * "identifer": "slot1",
             * "content": [ ]
            
            }
         
         }
      
      }
   
   ],
 * "depth": 1,
 * "is_home": 1,
 * "created_at": 123456789,
 * "updated_at": 123456789,
 * "is_visible": 1,
 * "meta_json": {
    * "description": "This is a meta description",
    * "image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg",
    * "title": "Hello World"
   
   },
 * "properties": {
    * "title": {
       * "value": "Hello World",
       * "navigation": true,
       * "propagate": false
      
      }
   
   },
 * "uid": "e4244ff7-e20e-40b9-b6a1-1117206aca14",
 * "type": "page",
 * "target": "_self",
 * "container": "default",
 * "breadcrumb": [
    * {
       * "slug": "hello-world",
       * "title": "Hello World"
      
      }
   
   ]

}


GET PAGE BY SLUG

This endpoint retrieves comprehensive information from a specified page using
either a slug or a path. The slug refers to a unique identifier for the page,
while the path is the slug with a leading slash. By providing either the slug or
the path as input, the function will gather all the relevant details associated
with the page.

AUTHORIZATIONS:

ApiToken

QUERY PARAMETERS

slug
string
Example: slug=foo/bar

The function retrieves a specific page by its slug. If no slug is provided, it
automatically returns the homepage. Moreover, it seamlessly handles paths with
subpages, allowing for nested URLs like "testpage/subpage". In this way, a
forward slash ("/") within the path is recognized as a valid character and
processed accordingly.

lang
string
Example: lang=de

The language context for the current request. If not defined, the defed primary
language will be used. If the nitro setup is not configured as multi lingual,
the language parameter won't have any effect


RESPONSES

200

OK

get/pages

Production Server

https://api.flyo.cloud/nitro/{version}/pages


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "id": 123,
 * "title": "About Me",
 * "href": "/about-me",
 * "slug": "about-me",
 * "json": [
    * {
       * "items": [
          * {
             * "title": "Hello",
             * "teaser": "Great!"
            
            },
          * {
             * "title": "Hallo",
             * "teaser": "Toll!"
            
            }
         
         ],
       * "content": {
          * "title": "Hello World"
         
         },
       * "config": {
          * "is_dark": true
         
         },
       * "identifier": "hero_image",
       * "uid": "e4244ff7-e20e-40b9-b6a1-1117206aca14",
       * "component": "HeroImage",
       * "slots": {
          * "slot1": {
             * "identifer": "slot1",
             * "content": [ ]
            
            }
         
         }
      
      }
   
   ],
 * "depth": 1,
 * "is_home": 1,
 * "created_at": 123456789,
 * "updated_at": 123456789,
 * "is_visible": 1,
 * "meta_json": {
    * "description": "This is a meta description",
    * "image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg",
    * "title": "Hello World"
   
   },
 * "properties": {
    * "title": {
       * "value": "Hello World",
       * "navigation": true,
       * "propagate": false
      
      }
   
   },
 * "uid": "e4244ff7-e20e-40b9-b6a1-1117206aca14",
 * "type": "page",
 * "target": "_self",
 * "container": "default",
 * "breadcrumb": [
    * {
       * "slug": "hello-world",
       * "title": "Hello World"
      
      }
   
   ]

}


ENTITIES


FIND ENTITY BY UNIQUEID

The endpoint provides comprehensive information about a specified entity. An
entity represents a collection of information pertaining to a specific data type
and is defined by a key-value pair. You can use various data types such as
blogs, events, or any other relevant data. However, in order to access an
entity, it must be properly configured within the nitro config.

AUTHORIZATIONS:

ApiToken

PATH PARAMETERS

uniqueid
required
string
Example: 2348uc

The unique identifier of the given entity is a string composed solely of
lowercase alphabetic characters (a-z) and numbers. This identifier is
meticulously generated for each data row, ensuring its uniqueness and
facilitating efficient data management and retrieval across content pools.

QUERY PARAMETERS

lang
string
Example: lang=de

The language context for the current request. If not defined, the defed primary
language will be used. If the nitro setup is not configured as multi lingual,
the language parameter won't have any effect


RESPONSES

200

OK

get/entities/uniqueid/{uniqueid}

Production Server

https://api.flyo.cloud/nitro/{version}/entities/uniqueid/{uniqueid}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "entity": {
    * "_version": 102,
    * "entity_metric": {
       * "api": "https://api.flyo.cloud/integration/metric/h/METRICS_HASH",
       * "image":
         "https://api.flyo.cloud/integration/metric/h/METRICS_HASH/pixel.gif"
      
      },
    * "entity_unique_id": "2348uc",
    * "entity_id": 1234,
    * "entity_image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg",
    * "entity_slug": "news-title-1",
    * "entity_teaser": "The quick brown fox jumps over the lazy dog",
    * "entity_time_end": 12345678,
    * "entity_time_start": 12345678,
    * "entity_title": "News Title #1",
    * "entity_type": "schema",
    * "entity_type_id": 123,
    * "updated_at": 123456789,
    * "routes": {
       * "detail": "view/<uniqueid>/<slug>"
      
      }
   
   },
 * "model": {
    * "title": "News Title #1",
    * "teaser": "The quick brown fox jumps over the lazy dog",
    * "slug": "news-title-1",
    * "image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg"
   
   },
 * "language": "de",
 * "jsonld": {
    * "@context": "https://schema.org/",
    * "@type": "Thing",
    * "name": "News Title #1",
    * "description": "The quick brown fox jumps over the lazy dog",
    * "image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg"
   
   }

}


FIND ENTITY BY SLUG AND OPTIONAL ENTITY-TYPE-ID

The endpoint allows for the retrieval of entities based on their slug, with an
optional Entity-Type-ID for more accurate results. The endpoint requires a slug
parameter to be passed in the path, which is necessary for identifying the
entity. However, since slugs are not unique across different entities, it is
highly recommended to also provide the typeId parameter through the query to
avoid incorrect or unintended results. This typeId serves as an
Entity-Definition-Schema ID, ensuring a more precise and targeted entity
retrieval by distinguishing the entities more clearly. The slug parameter is
mandatory and should be a string (e.g., 'hello-world'), while the typeId
parameter is optional and should be an integer (e.g., 123), representing the
Entity-Definition-Schema ID.

AUTHORIZATIONS:

ApiToken

PATH PARAMETERS

slug
required
string
Example: hello-world

When looking up an entity slug, it is advisable to provide the typeId parameter
along with it, as slugs are not unique among other entities. Failing to include
the typeId parameter may lead to unintended or incorrect results. By specifying
the typeId, you can ensure more accurate and targeted retrieval of the desired
entity.

QUERY PARAMETERS

typeId
integer
Example: typeId=123

To ensure accurate lookup, it is considered a best practice to include the
Type-ID of the entity associated with the slug. The Type-ID, alternatively
referred to as the Entity-Definition-Schema ID, serves as a crucial identifier
within the system. It uniquely distinguishes and categorizes the
Entity-Definition-Schema.

lang
string
Example: lang=de

The language context for the current request. If not defined, the defed primary
language will be used. If the nitro setup is not configured as multi lingual,
the language parameter won't have any effect


RESPONSES

200

OK

get/entities/slug/{slug}

Production Server

https://api.flyo.cloud/nitro/{version}/entities/slug/{slug}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "entity": {
    * "_version": 102,
    * "entity_metric": {
       * "api": "https://api.flyo.cloud/integration/metric/h/METRICS_HASH",
       * "image":
         "https://api.flyo.cloud/integration/metric/h/METRICS_HASH/pixel.gif"
      
      },
    * "entity_unique_id": "2348uc",
    * "entity_id": 1234,
    * "entity_image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg",
    * "entity_slug": "news-title-1",
    * "entity_teaser": "The quick brown fox jumps over the lazy dog",
    * "entity_time_end": 12345678,
    * "entity_time_start": 12345678,
    * "entity_title": "News Title #1",
    * "entity_type": "schema",
    * "entity_type_id": 123,
    * "updated_at": 123456789,
    * "routes": {
       * "detail": "view/<uniqueid>/<slug>"
      
      }
   
   },
 * "model": {
    * "title": "News Title #1",
    * "teaser": "The quick brown fox jumps over the lazy dog",
    * "slug": "news-title-1",
    * "image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg"
   
   },
 * "language": "de",
 * "jsonld": {
    * "@context": "https://schema.org/",
    * "@type": "Thing",
    * "name": "News Title #1",
    * "description": "The quick brown fox jumps over the lazy dog",
    * "image":
      "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg"
   
   }

}