iOS version
Before you start, ensure you have created your Apple Developer account, because it is mandatory to make the setting to generate the iOS version.
In general terms the same settings explained in this article need to be done in all the apps, there are exceptions for the Customer App, which also will be explained later in the article.
Please follow these steps to start the process:
Create the main identifier, also known as bundle ID or package name.
Go to your Apple Developer account https://developer.apple.com/
Next, go to the section called Identifiers https://developer.apple.com/account/resources/identifiers/list
Click on the Plus (+) button to add a new identifier
Select App IDs
Add your app name and bundle
You can find it in the Dashboard, like this https://d.pr/i/V76PTl
The platform will create it by default, but it can be changed at any time
The bundles must contain only letters
NOTE: Don’t forget to add to the identifiers the next required capabilities for each app
Select the capabilities according to the apps that you are setting up:
Customer App
Access wifi-information
App groups
Apple Pay payment processing
Associated domains
Maps
Push notifications
Sign in with Apple
Driver and Business App:
Access wifi-information
App groups
Associated domains
Maps
Push notifications
Note: If you don’t enable these capabilities in the identifiers, the app will fail
Create the Notification Extension identifier
Follow the same process but now you must add this text at the end of your identifier .OneSignalNotificationServiceExtension
For example: this is the main identifier com.orderingplus.app
For this extension, the identifier will look like this com.orderingplus.app.OneSignalNotificationServiceExtension
Remember that you need to add the same capabilities that were enabled in the main identifier
Create the app group, each app must have a different group
Click again Plus (+) button
Now select the option App Groups
You need to add the main identifier, plus this text .onesignal
Apple will add the word group. By default, please do not delete it
Your identifier will look like this com.orderingplus.app.onesignal
Create the Merchant ID
Note: this step is only for the Customer/Ordering App
Click again Plus (+) button
Now select the option Merchant IDs
You need to add the main identifier
Same as in the previous step, Apple will add this merchant. before your identifier, so please do not delete it, it will look like this merchant.com.orderingplus.app
Once the Merchant ID is created, please go to the Dashboard and add it in the section called Apple Merchant ID https://d.pr/i/OWf2GK
Final setup for the identifiers
Now go back to the Idenfitiers section
Open the identifier that you are setting up
Remember that the capabilities were set up for each identifier? Well now we need to add the App Group, and in the case of the Customer/Ordering App only, add the Merchant ID
Open the capability called App Groups, by clicking on the Edit button
Add the group that has the same identifier that you are setting up
Click on the Continue button to save the change
Merchant - Only for the Customer/Ordering App
Open the capability called Apple Pay Payment Processing, add the merchant created for the app, and continue to save the changes
Follow the same steps for the Notification Extension identifier, which was created in the step number 2
Create the API Key
Go to the Apple Store Connect page https://appstoreconnect.apple.com/
Next, go to the Users and Access section https://appstoreconnect.apple.com/access/users
Select the Integrations tab https://appstoreconnect.apple.com/access/integrations/api
Click on the Plus (+) button
Add the name that you like, add the access as admin, and click on the Generate button, like this https://d.pr/i/0i3uFT
Note: this file can only be accessed or downloaded 1 time
Download the newly created API Key file (.p8), save the file
Copy and save the Key ID and Issuer ID https://d.pr/i/ix88EJ because you will need this later in the Dashboard
Note: this key and IDs can be used for all the apps
Now let’s finish the settings in the Dashboard https://dashboard.orderingplus.com/
Basic App Settings, these sections are mandatory
Name
Package/Identifier
Version
Description
Constants
Apple Merchant ID - you will add the Merchant ID that was created previously in the Apple account
Google Maps API Key - If you have your own Maps API Key, then add it to this field
Facebook ID - this is for the Facebook Login feature, and can be empty in case you don’t have or don’t want to use this feature.
Google Reversed Client ID - this is for the Google Login option, the same as the previous field.
Intercom App ID and Intercome App Key - as the name says is to connect your Intercom chat account, same as the 2 previous settings can be empty in case, you don’t want or don’t have this feature.
Files, this section can be skipped, as those are part of the Logins options
App keys, in this section we’ll use the Key created in the Apple account
Team ID - is a unique identifier, which can be found in the Apple Developer account, like this https://d.pr/i/CL5AHu you can copy and paste it into the Dashboard
Itc team ID - can be skipped
API key ID, is the ID for the previous key created in the step number 5
API Key issuer ID, is the issuer ID that can be obtained after creating the API Key ID, which was created in the step number 5
API key file, in here upload the p8 file that was created in the step number 5
Click on the Save button to save the changes
NOTE: Sometimes, the dashboard will show a build error without showing a “certificate error” or “Provisional profile error” as usual. So if you search this text; “The requested URL returned error: 502” this means that there’s a problem with the servers, so you need to press build again.
Android version
This version is simpler compared to the iOS version, regardless you will find the information required especially the mandatory fields, as the information and keys can be provided by the support team.
Note: Keystore, is a file used in the Android version to upload an app to the Play Store, basically in a code that will be added internally in the app.
The information or section provided in this next section is regarding the Keystore file
Key alias - mandatory field
Key password - mandatory field
Store file - mandatory field - Keystore file in .jks format
Store password - mandatory field (is the same password as the Key password field)
Playstore credential file - optional
As mentioned before all this information can be provided by the support team.
Build apps process
Now that all the necessary steps are ready, the next and final step is to build or generate the files and QR codes for the apps, so they can be test
Scroll to the end of the page, to find this section
This will be divided into 2 sections, Android and iOS
You will find a few options, but in general terms, the TEST mode is to generate the app in a test version so it can be installed locally on your device, and the PRO version is the one used to upload the apps to the stores.
Android
It will have 4 different buttons, the most common will be the Build Test and Build AAB PRO, anyways the explanation will be explained next:
Build PRO, is an older version of the format that needs to be uploaded to the Play Store, this is for specific cases, if you are not sure if this is your case, please contact the support team
Build Test, is the test format to be able to install the apps directly on a device
Build AAB PRO, this is the format required for the Play Store, it means that if the app is going to be uploaded to the store, it must use this version and format.
Build AAB Debug, this is for advanced developers' options, you can skip this at any time.
iOS
You will find only 2 options
Build Test, is the test format to be able to install the apps directly on a device
iOS devices required a special setting to accomplish this
You will need your device’s UDID, can use this video to learn how
Then go to your Apple Developer account, and then enter the section called Devices https://developer.apple.com/account/resources/devices/list
Add your UDID
Enable the Developer mode in the device, following this articleThen go back to the Dashboard, and build the iOS app again
Build PRO, is the format necessary to upload the app to the App Store
Once you click in the TEST or PRO mode, the dashboard will start generating the app file and QR code, this will take a few minutes, and when the process is done, you will see the QR code is available to use.
Required fields to Build Your App
1. Accessing the Dashboard
Log in to the dashboard and click "My Products" in the left sidebar.
2. Add App Basic Settings
Configure the basic settings of your app:
Name
Package
Version
Description
3. Add Constants
Provide the following constants:
Merchant ID (available from Play Store or Apple Store) ex: merchant.com.ordering.app
Google Maps API Key(Optional but important for maps)
Facebook ID(Optional)
Google Reverse Client ID (Optional)
Intercom App ID(Optional)
Intercom App Key(Optional)
These constants are optional for building the app, but it is recommended to configure the Google Maps API Key for proper functionality.
The Facebook ID and Google Reverse Client ID are needed for Facebook login and Google login, respectively.
Intercom credentials are necessary only if you require Intercom integration in your apps.
All optional marked above, can be skipped and added later
4. Add Images for the App
Upload the images that will be displayed in your app:
Home Hero
Logotype
Empty Active Orders Section
Search Not Found Result
Empty Past Orders Section
Tutorial Images (6 images)
Store List Banner
Order Type Images:
Curbside
Delivery
Drive-thru
Eat-in
Pickup
Catering Delivery
Catering Pickup
All Categories Result Image
Long Logo
No Internet Image
Dummy Product Image
5. Configure Theme Colors
Add theme colors by entering a color code or selecting a color from the palette.
6. Add Google Services for Android and iOS
Upload the necessary Google services files (.json and .plist) in the "Files" section.
This step is optional or required only if you use Google login.
For instructions on obtaining these files, refer to this guide.
8. Build Resources
Upload images for the Apple and Android stores, such as
app icons
notification icons for Android
splash screens for both stores
9. Build Your App
Depending on your requirements, you can build your app in different modes:
Build Test: If you need the .ipa or .apk for testing
Build PRO: If you need the app to be signed for distribution
The Android .AAB file is the file you will use to distribute your app.
10. Done!
This guide will help you build and configure your apps from the Ordering dashboard. For any further assistance, please refer to the respective images provided for each step or contact the support team.