Introduction
The Appmiral Pages Importer allows you to import all your practical information (such as FAQs, rules, contact info, etc) from your website into Appmiral and keep them in sync. This importer expects a URL containing a valid JSON file conforming to our provided JSON structure. This URL can be a static .json file hosted online or public API endpoint.
Every 15 minutes, the importer will perform a request to the URL and sync the contents to your Appmiral CMS as Pages. This means that when the info is changed, it takes a maximum of 15 minutes before those changes are reflected in the Appmiral CMS and the app.
Translatable Fields
Translatable fields can be either a string or an object containing strings for multiple languages.
-
When a translatable field contains a simple string, it applies to the default language only.
-
When a translatable field contains an object, it sets values for each specified language. The default language must always be included. The key must be the short locale of the language!
In the example below, the "title" field is translatable but identical across all languages. In such cases, you may simply use a string for the field.
In the next example, the field name is translatable with different values for English and Dutch. When English is the default language, the "en" key must always be included.
Info: We currently support the following languages and locales: English (en), Arabic (ar), Czech (cs), Danish (da), Dutch (nl), Finnish (fi), French (fr), Galician (gl), German (de), Greenlandic (kl), Hebrew (he), Italian (it), Norwegian (nb), Polish (pl), Romanian (ro), Spanish (es), and Swedish (sv).
Note: Are you unsure which languages your application is using? Check your CMS or reach out to your dedicated Customer Success Manager.
Page Model All
|
Field |
Required |
Type |
Description |
|
id |
Yes |
string |
The ID of the page. Has to be unique for each page |
|
title |
Yes |
string | object (Translatable) |
The title of the page. |
|
parent |
no |
string |
The parent ID to which the page should be linked to. |
|
body |
no |
string | object (Translatable) |
The body for the page. |
|
url |
no |
string | object (Translatable) |
The url to link to. |
|
priority |
no |
integer (Default: 100) |
The priority of the page. |
|
tags |
no |
array of strings |
A list of tags to link to the page. Tags are slugs which should be lowercase and can contain a-z, 0-9 and - |
|
faq_items |
no |
array of faq_items (see below) |
A array containing the FAQ items. |
JSON Example
Page Model Type Page
|
Field |
Required |
Type |
Description |
|
id |
Yes |
string |
The ID of the page. Has to be unique for each page |
|
title |
Yes |
string | object (Translatable) |
The title of the page. |
|
parent |
no |
string |
The parent ID to which the page should be linked to. |
|
body |
Yes |
string | object (Translatable) |
The body for the page. |
|
priority |
no |
integer (Default: 100) |
The priority of the page. |
|
tags |
no |
array of strings |
A list of tags to link to the page. Tags are slugs which should be lowercase and can contain a-z, 0-9 and - |
JSON Example
Page Model Type Folder
|
Field |
Required |
Type |
Description |
|
id |
Yes |
string |
The ID of the page. Has to be unique for each page |
|
title |
Yes |
string | object (Translatable) |
The title of the page. |
|
parent |
no |
string |
The parent ID to which the page should be linked to. |
|
priority |
no |
integer (Default: 100) |
The priority of the page. |
|
tags |
no |
array of strings |
A list of tags to link to the page. Tags are slugs which should be lowercase and can contain a-z, 0-9 and - |
JSON Example
Page Model Type URL
|
Field |
Required |
Type |
Description |
|
id |
Yes |
string |
The ID of the page. Has to be unique for each page |
|
title |
Yes |
string | object (Translatable) |
The title of the page. |
|
parent |
no |
string |
The parent ID to which the page should be linked to. |
|
url |
no |
string | object (Translatable) |
The url to link to. |
|
priority |
no |
integer (Default: 100) |
The priority of the page. |
|
tags |
no |
array of strings |
A list of tags to link to the page. Tags are slugs which should be lowercase and can contain a-z, 0-9 and - |
JSON Example
Page Model Type FAQ
|
Field |
Required |
Type |
Description |
|
id |
Yes |
string |
The ID of the page. Has to be unique for each page |
|
title |
Yes |
string | object (Translatable) |
The title of the page. |
|
parent |
no |
string |
The parent ID to which the page should be linked to. |
|
priority |
no |
integer (Default: 100) |
The priority of the page. |
|
tags |
no |
array of strings |
A list of tags to link to the page. Tags are slugs which should be lowercase and can contain a-z, 0-9 and - |
|
faq_items |
no |
array of faq_items (see below) |
A array containing the FAQ items. |
FAQ Items Model
|
Field |
Required |
Type |
Description |
|
id |
Yes |
string |
The ID of the page. Has to be unique for the faq |
|
question |
Yes |
string | object (Translatable) |
The question for the faq_item |
|
answer |
Yes |
string | object (Translatable) |
The question for the faq_item |
|
priority |
no |
integer (Default: 100) |
The priority of the page. |
JSON Example