DOCS

FAWI

Fawi stands for Full Apps Without Installations.. Fawi is a two environments platform, the Fawi Office to create and distribute apps and the Fawi Store for users to access the Fawi Apps without installing them. Users can access all Fawi Apps just installing the Fawi Store on their devices.

Fawi Apps

A Fawi app is a combination between a Web Link and the Fawi platform. So you can develop any Web App (html, css, javascript) using a single codebase, combined with Fawi Native resources (optional), and Publish it on the Fawi Office, providing users cross platform apps without installations and with native full experience through Fawi Store.

Already have an app?

If you already developed apps in the technologies below, follow the next tutorials to Publish on Fawi.

• HTML / PWA / CMS to Fawi
• Ionic to Fawi
• React to Fawi
• Cordova to Fawi
• Flutter to Fawi

To create an app, follow the next steps:

1. Open Fawi Office.
2. Click the bottom right button to open the Create App page.
3. Enter the app information and click the Save button.
   NOTE: After you create an app, the app appers on Fawi Office, and the app status is Edited. You can edit it anytime.

Before publishing your app, make sure it’s ready to be publicly released and that you’re making the most of it.

• Settings
• Server
• Store Info
• Locals
• Device
• Monetize

Settings

Server

Enter the server information.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Publish Settings to open the Publish Settings page.
   NOTE: You can reach this stage clicking the app icon on an app card.
4. Tap the Server tab.
5. Setup your server.
6. Click the Save button.

The App Keys are automatically generated when an app is created, but they can be reseted. Use the App Public Key in your client-side code and the App Secret Key to authenticate Fawi API requests on your server.

Reveal you App Keys:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Publish Settings to open the Publish Settings page.
   NOTE: You can reach this stage clicking the app icon on an app card.
4. Tap the Server tab.
5. Scroll to the App Keys section.
6. Click the button to open the Reveal dialog.
7. Enter the Admin Password and click the Reveal button.

Reset you App Secret Key:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Publish Settings to open the Publish Settings page.
   NOTE: You can reach this stage clicking the app icon on an app card.
4. Tap the Server tab.
5. Scroll to the App Keys section.
6. Click the Reset Secret Key button, to open the Reset dialog.
7. Enter the Admin Password and click the Reset button.

If your are using Basic Authentication security, you need to add the credentials [Username/Password] to allow Fawi access.
Learn More

Reveal basic authentication security credentials:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Publish Settings to open the Publish Settings page.
   NOTE: You can reach this stage clicking the app icon on an app card.
4. Tap the Server tab.
5. Scroll to the Basic Authentication section.
6. Click the button to open the Reveal dialog.
7. Enter the Admin Password and click the Reveal button.

Store Info

Manage your app content and information.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Publish Settings to open the Publish Settings page.
   NOTE: You can reach this stage clicking the app icon on an app card.
4. Tap the Store Info tab.
5. Provide all app content and information.
   NOTE: This content and information is used to represent your app in different sections of the Fawi Store.
6. Click the Save button.

Once you are in the Store Info tab.

1. Click upload , to open the App Icon page.
2. Select an icon and click the Done button.
   NOTE: Fawi Office dynamically render rounded corners for your app icon, you should omit it from your original asset.
3. Click the Save button.

When creating your artwork, ensure it conforms to the following:

Size: 500px x 500px

Format: PNG, JPG, JPEG, WEBP

Shape: Full square

NOTE: The icon should fill the Fawi Terms requirements.

Once you are in the Store Info tab.

1. Scroll down to the App Cover section.
2. Click upload , to open the App Cover page.
3. Select a cover and click the Done button.
4. Click the Save button.

When creating your artwork, ensure it conforms to the following:

Format: PNG, JPG, JPEG, WEBP

NOTE: The cover should fill the Fawi Terms requirements.

Once you are in the Store Info tab.

1. Scroll down to the App Video Spot section.
2. Click the Upload button, to select a video.
3. Click the Save button.

When editing your video, ensure it conforms to the following:

Size: 720px x 1280px or more with (16:9 aspect ratio)

Format: MP4, WEBM

Duration: 30 seconds or less

NOTE: The video spot should fill the Fawi Terms requirements.

Once you are in the Store Info tab.

1. Scroll down to the Description section.
2. Click the Edit button, to open the Description page.
3. Enter your app description and click the Done button.
   NOTE: Enter useful information about the app, that describes how it works.
4. Click the Save button.

Once you are in the Store Info tab.

1. Scroll down to the Prints section.
2. Click upload , to select a print.
   NOTE: Select prints that illustrates the app user interface experience.
3. Click the Save button.

NOTE: The Publisher Web Site and the Terms and Policy URL are optional, but if specified they need to be validated as same as the App Base URL.

Adding the <meta> tag to the page HTML document:

Developer Web Site home page HTML Document:
<!DOCTYPE html>
<html lang="en">
<head>
...
<meta name="fawi-developersite-validation" content="app_public_key">
...
</head>

Terms and Policy Web Site home page HTML Document:
<!DOCTYPE html>
<html lang="en">
<head>
...
<meta name="fawi-termsite-validation" content="app_public_key">
...
</head>

Locals

In case your app belongs to the Services category, usualy intended for local services, you can add addresses and coordinates using a map in the Locals tab on your app main menu, allowing the users to find your app through GPS position on Fawi Store.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Publish Settings to open the Publish Settings page.
   NOTE: You can reach this stage clicking the app icon on an app card.
4. Tap the Locals tab.
5. Click the bottom right button to open the Add Locals page:
• Enter the place name .
• Specify the local region.
  NOTE: The region appears in the map below.
• Click the Save button.
  NOTE: The local appers in the Locals tab.

Device

Manage how your app looks like in the users devices.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Publish Settings to open the Publish Settings page.
   NOTE: You can reach this stage clicking the app icon on an app card.
4. Tap the Device tab.
5. Customize how your app looks like in the users devices.
6. Click the Save button.

Subscribe to a Fawi Authentication Plan for authenticating users on your app.

Once you are in the Device tab:

1. Scroll to the Fawi Account Authentication section.
2. Click the Subscribe button, to open the Fawi Authentication plans.
3. Subscribe to a plan.

Subscribe to a Fawi Notification Plan, to get in touch with the app users to re-engage and retain them. Customize how the notifications looks like for users, by setting up the icon, sound and color. [All Optional]

Once you are in the Device tab:

1. Scroll to the Notification section.
2. Click the Subscribe button, to open the Fawi Notification plans.
3. Subscribe to a plan.
4. Click upload icon , to select an icon.
   NOTE: If you don't select an icon, Fawi uses the app icon.
5. Click upload sound , to select a sound.
6. Pick a color or enter the color hex code.

Specify if your app is provided in offline mode or not. To provide it in offline mode, you must download the fawiOfflineMaker file for your server operating system and run it in your App Public Folder or in the command line with the folder path as parameter. Learn more

Once you are in the Device tab:

1. Scroll to the Offline App section.
2. Click the Download button with your server operating system icon, to download the fawiOfflineMaker file.
3. Run the file in your App Public Folder or in the command line with the folder path as parameter.

Running the file in the command line, supposing the fawiOfflineMaker is in the downloads folder:

Linux
linux@linux-pc:~/Downloads$ fawiOfflineMaker.sh ~/path
...
Mac
mac@mac-pc:~/Downloads$ fawiOfflineMaker.sh ~/path
...
Windows
C:\Users\windows\Downloads> fawiOfflineMaker.bat ~/path

Add the MIME Types your app supports to Open and Share. [All Optional]

Once you are in the Device tab:

1. Scroll to the Open / Share section.
2. Enter your app Open / Share URL.
3. Click the Share File MIME Types, then select the MIME Types.
4. Click the Open File MIME Types, then select the MIME Types.

Select the Fawi current version that supports your app.

Select your app supported devices.

Specify the minimum hardware requirements to run your app. [Optional]

Monetize

Monetize your app defining a Plan price on Fawi Store, by few clicks, or by using the Fawi Wallet API In-App Purchases. Earn 100% of revenues without Fawi comissions and taxes for minim withdraw values.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Publish Settings to open the Publish Settings page.
   NOTE: You can reach this stage clicking the app icon on an app card.
4. Tap the Monetize tab.
5. Select a payment method, then generate a plan.
6. Click the Save button.

Monetize your app.

Once you are in the Monetize tab:

1. Scroll to the App Plan Price On Store section.
2. Select a paymend method.
3. Click the Add New Plan button, to open the Generate Plan Price Id page.
4. Select a plan type.
5. Fill in the form.
6. Click the Confirm button, to generate a plan.
7. Click the Save button.

Select the app play time for the Arcade Mode For Games plan type and the app trial time.

The app Merchant Keys are automatically generated when an app is created.

Reveal you app Merchant Keys.

Once you are in the Monetize tab:

1. Scroll to the Merchant Keys section.
2. Click the button to open the Reveal dialog.
3. Enter the Admin Password and click the Reveal button.

Publish

We review all apps, app updates, in-app purchases, and in-app events submited to the Fawi Store. Helping to provide a safe and trusted experience for users and the opportunity for developers to succeed. Before publishing, you’ll need to provide all required information. If there's no issue the app is validated and it will be ready to be distributed on the Fawi Store, oterwise the app is rejected.

Submit an app to review:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Publish Settings to open the Publish Settings page.
   NOTE: You can reach this stage clicking the app icon on an app card.
4. Click the Publish button, to open the Publish App page.
   NOTE: The button is enabled once you provided all the required information.
5. Click the Submit button, to open the Publish dialog.
6. Click the Yes button.
   NOTE: The app is submited to review and the state changes from Edited to Pendent on the Fawi Office.

The app settings can be reverted to the last published version before get approved by the Fawi staff.

Unpublish an app:

1. Open Fawi Office.
2. At the center of an app card, tap the Pendent state, to open the Published App page.
3. Click the Cancel Publish button, to open the Unpublish dialog.
4. Click the Yes button.
   NOTE: The app state changes from Pendent to Edited on the Fawi Office.

Subscribe to the Fawi Plans, to authenticate, deploy, send notifications and publish you apps to the Fawi Store.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Fawi Plans to open the Fawi Plans page.
4. Tap the tabs to choose the solutions you need and subscribe.

Boost your App on Fawi Ads, to appear on strategic places of user experience and get more app accesses.

Boost your apps through the app menu:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Boost to open the Boost page.
4. Click the Boost button.
5. Set you Budget.
   NOTE: You can set your budget anytime or add credits to it.

Boost you apps clicking the Boost App button at an app card:

1. Open Fawi Office.
2. At the bottom of an app card, click the Boost App button to open the Boost page.
3. Click the Boost button.
4. Set you Budget.
   NOTE: You can set your budget anytime or add credits to it.

Fawi provides two ways to send notifications to your app users.

Send notifications on the Notifications page on the Fawi Office, that allows you to send messages to all users:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Notifications to open the Notifications page.
4. Fill in the form and click the Send button.
   NOTE: In order to send notifications, you need to subscribe to a Fawi plan.

Creating your own notification system by using the Fawi Notification API, that allows you to send notifications to topics.

Invite restricted users to use your app in Restricted Public Mode.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Restricted Users to open the Restricted Users page.
4. In the Restricted Users page, click the bottom right button to open the Invite dialog:
• Enter the recipient’s email.
• Click the OK button.
5. Fill in the form and click the Invite button.
   NOTE: The user appers in the Restricted Users page. You can edit it anytime.

Invite colaborators to help you manage your Apps.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Managers to open the Managers page.
   NOTE: In order to invite a manager, you need to subscribe to a Fawi plan.
4. In the Managers page, click the bottom right button to open the Invite dialog:
• Enter the recipient’s email.
• Click the OK button.
5. Fill in the form and click the Next button.
6. Select the permissions, then click the Next button.
7. Click the Finish button.
   NOTE: The manager appers in the Managers page. You can edit it anytime.

View how your app is growing.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Statistics to open the Statistics page.
4. Tap the tabs to view your apps growth.

View your app Ads earned credits:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Revenues to open the Revenues page.
4. Tap the Ads Earns tab.

Refund your app Ads earned credits:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Revenues to open the Revenues page.
4. Tap the Ads Earns tab.
5. Click the Refund button, to open the Ads Credits Earns Refund page.
6. Select the refund modality, then click the Confirm button.

View your app Ads earned credits refund historic:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Revenues to open the Revenues page.
4. Tap the Ads Earns tab.
5. Click the Historic button, to open the Refund Historic page.

View your app Wallet earnes:

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Revenues to open the Revenues page.
4. Tap the Wallet Earns tab.

A different environment that simulates the original app and provides tools for testing before publishing.

View all the invoices issued to an app.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Invoices to open the Invoices page.
4. Click download , to download an invoices.

You can transfer the ownership of an app to another user by sending a transfer invitation. Once the recipient accepts the invitation, he gets all the ownership permmissions and the app is removed from your account.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Transfer to open the Transfer page.
4. In the Transfer page, click the bottom right button to open the Invite dialog:
• Enter the recipient’s email.
• Click the OK button.
5. Insert the Admin Password and click the Invite button.
   NOTE: The user appers in the Transfer page. You can cancel the invitation before the recipient accepts it.

What happens during and after an app transfer

After an app is transferred, the app is associated to the recipient’s user account. During a transfer the merchant Keys are not transferred along with the app, a new merchant Keys are created and associated with the recipient’s account.

Once you delete an App, you will not be able to get it back.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. From the app main menu, select Delete to open the Delete dialog.
4. Insert the Admin Password and click the Delete button.
   NOTE: The app is removed from your account.

Open the App Deep Link from App menu to download the QR code so users can find the App through the link.

1. Open Fawi Office.
2. At the top right of an app card, tap more .
3. At the top right of an app main menu, click QR Code , to open the App Deep Link page.
4. Copy the Deep Link to the clipboard clicking the Copy button or click the Download buttons to download the Sticket and the QR Code.