Geodesic Solutions Community Wiki

User Tools

Site Tools

You are here: Auction and Classified Software Support Home » Addons » Mobile API (GeoMobile iPhone App)
addons:mobile_api:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
addons:mobile_api:start [2012/03/08 17:36]
jonyo [iPhone App Updates] 		addons:mobile_api:start [2014/09/25 16:55] (current)
Line 2: Line 2:
  
 The Mobile API addon is used to allow visitors on your site to use the **GeoMobile iPhone App** OR your own **Personal iPhone App** to connect to your site.  The full list of steps looks a little long, but really it is just describing in detail the 4 main parts, as illustrated on the [[http://geodesicsolutions.com/component/content/article/53-added-value/356-mobile-api-app.html?directory=64|Mobile API Addon page]]. The Mobile API addon is used to allow visitors on your site to use the **GeoMobile iPhone App** OR your own **Personal iPhone App** to connect to your site.  The full list of steps looks a little long, but really it is just describing in detail the 4 main parts, as illustrated on the [[http://geodesicsolutions.com/component/content/article/53-added-value/356-mobile-api-app.html?directory=64|Mobile API Addon page]].
 +
 +<tip c n>**License Requirement:**  Note that unlike other addons, the Mobile API addon is fully encoded for security and software licensing reasons, and **requires Ioncube**.  It will not work if your server only has Zend Optimizer.</tip>
  
 ====== Complete Steps ====== ====== Complete Steps ======
Line 7: Line 9:
 The steps below are one complete set of instructions, meant to be used from "start" to "finish" to get the iPhone app working on your site. The steps below are one complete set of instructions, meant to be used from "start" to "finish" to get the iPhone app working on your site.
  
-===== Step 1: Addon Purchase / Installation =====+===== Part 1: Addon Purchase / Installation =====
  
   - Purchase the addon from the client area and install on your website by following the normal [[addons/install/start|Addon Installation Instructions]].   - Purchase the addon from the client area and install on your website by following the normal [[addons/install/start|Addon Installation Instructions]].
     * Note that you have 2 main choices, either the shared **GeoMobile iPhone App** (shared app published by us), OR your own **Personalized iPhone App** (published using your own account). <     * Note that you have 2 main choices, either the shared **GeoMobile iPhone App** (shared app published by us), OR your own **Personalized iPhone App** (published using your own account). <
-    * There are also several different payment options to choose from((Unlike other addons, this is the first one that offers different leased options.)), as described [[http://geodesicsolutions.com/latest-software-news-blog/355-geomobile-iphone-app-is-released-waiting-list-for-personal-app-is-open.html|here]]. < 
 < <
  
Line 17: Line 18:
  
  
-===== Step 2: Addon & Site Key Setup =====+===== Part 2: Addon & Site Key Setup =====
  
   - Once the addon is installed and enabled, go to the page [[admin_menu/addons/mobile_api/manage_devices/start|Addons > Mobile API > Manage Devices]] in your admin panel. <   - Once the addon is installed and enabled, go to the page [[admin_menu/addons/mobile_api/manage_devices/start|Addons > Mobile API > Manage Devices]] in your admin panel. <
Line 23: Line 24:
   - Click the button **Register/Request GeoMobile Site Key**((Note that you need your own Site Key even if using the Personalized iPhone App, as that is how we will identify your personal iPhone app later on.)) <   - Click the button **Register/Request GeoMobile Site Key**((Note that you need your own Site Key even if using the Personalized iPhone App, as that is how we will identify your personal iPhone app later on.)) <
   - In the box that shows, enter the site name as you would like it to appear within the GeoMobile iPhone App((Note that you CAN change this at a later date))((You are limited to 13 characters, as that is how many will fit on the iPhone title bar, and can only use A-Z, 0-9, spaces, underscores(_), and dashes(-).  Note that "accented" and "non-Latin" characters (such as Arabic) are not permitted.)), then click the **Register Site Key!** button. <   - In the box that shows, enter the site name as you would like it to appear within the GeoMobile iPhone App((Note that you CAN change this at a later date))((You are limited to 13 characters, as that is how many will fit on the iPhone title bar, and can only use A-Z, 0-9, spaces, underscores(_), and dashes(-).  Note that "accented" and "non-Latin" characters (such as Arabic) are not permitted.)), then click the **Register Site Key!** button. <
-  - When you are successfully registered, your very own **GeoMobile Site Key** will appear on the page.  This is the number visitors will enter into the **GeoMobile iPhone App** to connect to your site.  Or if you are using the personal iPhone app, this is how we will identify your app customizations. <+  - When you are successfully registered, your very own **GeoMobile Site Key** will appear on the page.  This is the value that visitors will enter into the **GeoMobile iPhone App** to connect to your site.  Or if you are using the personal iPhone app, this is how we will identify your app customizations. <
  
-===== Step 3: Personal App Customization =====+===== Part 3: Personal App Customization =====
  
 This section only applies to **Personal iPhone Apps**, if you are using the **GeoMobile iPhone App** you will need to skip this section. This section only applies to **Personal iPhone Apps**, if you are using the **GeoMobile iPhone App** you will need to skip this section.
  
-  - If you have not already, you will need to enroll in the [[https://developer.apple.com/programs/ios/|iOS Developer Program]], in order to be able to publish your own personalized iPhone App to the App Store.  Note that there is a $99/Year Enrollment fee paid to Apple for the required enrollment in iOS Developer Program, and that is in addition to any costs paid to us for the personalized iPhone app itself.((Note that sites using the shared **GeoMobile iPhone App** do **not** need to be enrolled in the iOS Developer Program, as we publish the GeoMobile iPhone App under our own iOS Developer Account.))+<tip c n>**Software Version Requirement:** Due to recently-added restrictions in Apple's approval process, your main site must be running **GeoCore 7.3.0 or higher** in order to create a new Personalized app.</tip> 
 + 
 +  - If you have not already, you will need to enroll in the [[https://developer.apple.com/programs/ios/|iOS Developer Program]], in order to be able to publish your own personalized iPhone App to the App Store.  Note that there is a $99/Year Enrollment fee paid to Apple for the required enrollment in iOS Developer Program, and that is in addition to any costs paid to us for the personalized iPhone app itself.((Note that sites using the shared **GeoMobile iPhone App** do **not** need to be enrolled in the iOS Developer Program, as we publish the GeoMobile iPhone App under our own iOS Developer Account.))  While you are waiting for Apple to approve your account, you can continue on with the steps below, up to step 6. <
   - Go to the [[https://geodesicsolutions.com/iphone_util/customize/|Secure iPhone Personalization Tool]], and **log in** with your client area e-mail and password.  If you do not know your client area password, visit the [[https://geodesicsolutions.com/geo_store/customers/index.php?task=login|client area login]] and use the //forgot password// tool. <   - Go to the [[https://geodesicsolutions.com/iphone_util/customize/|Secure iPhone Personalization Tool]], and **log in** with your client area e-mail and password.  If you do not know your client area password, visit the [[https://geodesicsolutions.com/geo_store/customers/index.php?task=login|client area login]] and use the //forgot password// tool. <
   - If you have multiple iPhone apps for different sites, select which one you will be customizing.  If you only have one it will already be selected for you.((Note that if you have not already followed [[#Part A: Addon Installation & Setup]], you will not be able to proceed, as the Personalization Tool requires that you have registered for a site key for your iPhone app license.)) <   - If you have multiple iPhone apps for different sites, select which one you will be customizing.  If you only have one it will already be selected for you.((Note that if you have not already followed [[#Part A: Addon Installation & Setup]], you will not be able to proceed, as the Personalization Tool requires that you have registered for a site key for your iPhone app license.)) <
   - Visit each of the first 4 tabs in the tool, each tab allows you to customize a different part of the iPhone App.  The last tab is only used when you are finished with your customizations and wish to send them in to us to create (or update) your app. <   - Visit each of the first 4 tabs in the tool, each tab allows you to customize a different part of the iPhone App.  The last tab is only used when you are finished with your customizations and wish to send them in to us to create (or update) your app. <
   - When you are finished customizing, save your changes using the **save** button at the bottom of the page.  Note that you can save your changes at any time, leave, and come back later to finish your customizations, as the tool will save your changes and bring them up the next time you log in. <   - When you are finished customizing, save your changes using the **save** button at the bottom of the page.  Note that you can save your changes at any time, leave, and come back later to finish your customizations, as the tool will save your changes and bring them up the next time you log in. <
-  - Double check all of your changes, make sure everything is like you want. Note that repeated "customization change updates" may be subject to additional service fees((Since each time you request an update, the changes must be manually submitted by one of our developers on your behalf.)), so try your best to get it "right the first time" to avoid extra fees. < +  - Double check all of your changes, make sure everything is like you want. Note that repeated "Request App Updates" may be subject to additional service fees((Since each time you request an update, the changes must be manually submitted by one of our developers on your behalf.)), so try your best to get it "right the first time" to avoid extra fees. < 
-  - When you are satisfied with the changes, go to the last tab labeled **Request App Update**.+  - When you are satisfied with the changes, and once your iOS Developer account is activated by Apple, go to the last tab labeled **Request App Update**.
   - Fill out all of the fields on the last tab.  If there are any "special instructions" be sure to note them in the **Additional Instructions to the Developer** box.  For the **Update Type**:   - Fill out all of the fields on the last tab.  If there are any "special instructions" be sure to note them in the **Additional Instructions to the Developer** box.  For the **Update Type**:
     * **First Time** : No previous version : Use this if it is the first time and you do not already have a personalized iPhone app in the system. <     * **First Time** : No previous version : Use this if it is the first time and you do not already have a personalized iPhone app in the system. <
-    * **Minor Updates** : x.**x**.**x**.x((Includes when any of the bolded parts of the version are updated.  For instance x.**x**.x.x might mean update from 1.**2**.0.1 to 1.**3**.0.0.)) : Use this if you already have a personalized iPhone app, and we release a new version of the **GeoMobile Iphone App** that is a //minor update//, meaning the //first number// is staying the same but the second and/or third number is higher than the version you are currently using. < +    * **Minor Updates** : x.**X**.**X**.x((Includes when any of the bolded parts of the version are updated.  For instance x.**X**.x.x might mean update from 1.**2**.0.1 to 1.**3**.0.0.)) : Use this if you already have a personalized iPhone app, and we release a new version of the **GeoMobile Iphone App** that is a //minor update//, meaning the //first number// is staying the same but the second and/or third number is higher than the version you are currently using. < 
-    * **Major Updates** : **x**.x.x.x((Includes when any of the bolded parts of the version are updated.  For instance x.**x**.x.x might mean update from 1.**2**.0.1 to 1.**3**.0.0.)) : Use this if you already have a personalized iPhone app, and we release a new version of the **GeoMobile Iphone App** that is a //major update//, meaning the //first number// is higher than the version you are currently using. < +    * **Major Updates** : **X**.x.x.x((Includes when any of the bolded parts of the version are updated.  For instance x.**X**.x.x might mean update from 1.**2**.0.1 to 1.**3**.0.0.)) : Use this if you already have a personalized iPhone app, and we release a new version of the **GeoMobile Iphone App** that is a //major update//, meaning the //first number// is higher than the version you are currently using. < 
-    * **Customizations ONLY** : x.x.x.**x**((Includes when any of the bolded parts of the version are updated.  For instance x.**x**.x.x might mean update from 1.**2**.0.1 to 1.**3**.0.0.)) : Use this if you already have a personalized iPhone app, and want to update the customized text/images/colors without using a newer version of the main software.  Note that repeated Customizations ONLY updates may require additional service fees. <+    * **Customizations ONLY** : x.x.x.**X**((Includes when any of the bolded parts of the version are updated.  For instance x.**X**.x.x might mean update from 1.**2**.0.1 to 1.**3**.0.0.)) : Use this if you already have a personalized iPhone app, and want to update the customized text/images/colors without using a newer version of the main software.  Note that repeated Customizations ONLY updates may require additional service fees. <
 < <
   - When you have filled in all the fields on the **Request App Update** tab, at the bottom of the tab click the button **request app update**.   - When you have filled in all the fields on the **Request App Update** tab, at the bottom of the tab click the button **request app update**.
Line 51: Line 54:
   - To change the App **price**, App **Description**, or any of the **Meta information** about your app, log in to [[https://itunesconnect.apple.com/|iTunes Connect]]. We will be submitting the app on your behalf with a few "defaults" such as "$0 cost" and a default app description, which you can change after we have initially set up the app in your iOS Developer account. <   - To change the App **price**, App **Description**, or any of the **Meta information** about your app, log in to [[https://itunesconnect.apple.com/|iTunes Connect]]. We will be submitting the app on your behalf with a few "defaults" such as "$0 cost" and a default app description, which you can change after we have initially set up the app in your iOS Developer account. <
  
-===== Step 4: Advertise the App =====+===== Part 4: Advertise the App =====
  
   - Within your templates, let your visitors know how to get the iPhone app and how to use it to connect to your site.  For the shared **GeoMobile iPhone app**, you can use the addon tag **{addon author='geo_addons' addon='mobile_api' tag='show_site_key'}** which will display the site key, or can enter your site key into the templates directly. <   - Within your templates, let your visitors know how to get the iPhone app and how to use it to connect to your site.  For the shared **GeoMobile iPhone app**, you can use the addon tag **{addon author='geo_addons' addon='mobile_api' tag='show_site_key'}** which will display the site key, or can enter your site key into the templates directly. <
Line 57: Line 60:
 ====== iPhone App Version Numbers ====== ====== iPhone App Version Numbers ======
  
-The GeoMobile iPhone app version number has 3 parts, something like **1.2.3**.  The personal iPhone app will have 4 parts, the first 3 will coorespond to what version of the GeoMobile iPhone App was used to generate the personal app.+The GeoMobile iPhone app version number has 3 parts, something like **1.2.3**.  The personal iPhone app will have 4 parts, the first 3 will coorespond to what version of the GeoMobile iPhone App was used to generate the personal app.  Each version number part is described below:
  
 **Version Parts 1.2.3.4** **Version Parts 1.2.3.4**
Line 73: Line 76:
 **Using Personal iPhone App:** **Using Personal iPhone App:**
  
-If we release a new version of the GeoMobile iPhone app, you have the option to update your personalized iPhone app as well, however updating is not compulsory.  To request an update, follow the instructions in [[#Step 3: Personal App Customization]] again, this time it will already have your previous customizations in place.  Look over those customizations, also keep an eye out for any new text, colors, or images that may have been added in the new version.+If we release a new version of the GeoMobile iPhone app, you have the option to update your personalized iPhone app as well, however updating is not compulsory.  To request an update, follow the instructions in [[#Part 3: Personal App Customization]] again, this time it will already have your previous customizations in place.  Look over those customizations, also keep an eye out for any new text, colors, or images that may have been added in the new version.
  
 Note that the [[https://geodesicsolutions.com/iphone_util/customize/|Secure iPhone Personalization Tool]] that you use to request updates to your app, will always allow you to request an update.  Just because it lets you submit the request does not mean you do not need to pay anything for the update; if you already know that you will need to pay a service fee go ahead and pay that before submitting the form to speed the process up.  Otherwise, if you do not pay before hand, when you submit the request we will let you know what you will need to pay and the update will be put on hold until you have made payment. Note that the [[https://geodesicsolutions.com/iphone_util/customize/|Secure iPhone Personalization Tool]] that you use to request updates to your app, will always allow you to request an update.  Just because it lets you submit the request does not mean you do not need to pay anything for the update; if you already know that you will need to pay a service fee go ahead and pay that before submitting the form to speed the process up.  Otherwise, if you do not pay before hand, when you submit the request we will let you know what you will need to pay and the update will be put on hold until you have made payment.
  
-===== Why called Mobile API? =====+====== Why called Mobile API? ======
  
 Currently the addon only works with the GeoMobile iPhone App, which is developed and maintained in-house.  In the future we plan to create apps for other mobile devices. When that happens they will be integrated into this same Addon.  That is why we call the addon **Mobile API**: since going forward it will work to connect more than just to the iPhone app((When we do create apps for more mobile devices, additional license fees may be required for the additional devices -- no prices are set at this time.)). Currently the addon only works with the GeoMobile iPhone App, which is developed and maintained in-house.  In the future we plan to create apps for other mobile devices. When that happens they will be integrated into this same Addon.  That is why we call the addon **Mobile API**: since going forward it will work to connect more than just to the iPhone app((When we do create apps for more mobile devices, additional license fees may be required for the additional devices -- no prices are set at this time.)).
  
-===== GeoMobile "shared" iPhone App VS Personal iPhone App =====+====== GeoMobile "shared" iPhone App VS Personal iPhone App ======
  
 See the differences between the shared GeoMobile iPhone app and the Personal iPhone app below: See the differences between the shared GeoMobile iPhone app and the Personal iPhone app below:
Line 87: Line 90:
 **Both**: **Both**:
   * Both use this Mobile API addon, that allows the iPhone app to "talk to" your website.  The only difference is the license key entered (see the installation instructions above) will be different for a personalized iPhone app. <   * Both use this Mobile API addon, that allows the iPhone app to "talk to" your website.  The only difference is the license key entered (see the installation instructions above) will be different for a personalized iPhone app. <
-  * Both require at least Geo version 6.0.4 or higher <+  * Both require at least Geo version 6.0.5 or higher <
   * Both require Ioncube, currently it will not work with Zend Optimizer.   * Both require Ioncube, currently it will not work with Zend Optimizer.
   * Both use the same installation instructions above to install the addon in the Geo software. <   * Both use the same installation instructions above to install the addon in the Geo software. <
   * Both can use the latest version of the app, and get updates to the app going forward. <   * Both can use the latest version of the app, and get updates to the app going forward. <
-  * Both use recurring pricing, although the specific price is different, and the access to software updates is tied to the recurring license.((Note that this is different than most of the other addons we provide, which are a one-time cost.)) < 
  
  
 **GeoMobile iPhone App**: **GeoMobile iPhone App**:
-  * Your visitors download the shared **GeoMobile** iPhone app, and enter in your unique site key to connect to your specific site. <+  * Your visitors download the shared [[https://itunes.apple.com/us/app/geomobile/id473774461|GeoMobile iPhone app]], and enter in your unique site key to connect to your specific site. <
   * Your "site name" is displayed, but all other app text is **not changeable** and only available in English. <   * Your "site name" is displayed, but all other app text is **not changeable** and only available in English. <
   * All text, images, and colors are **not** able to be customized. <   * All text, images, and colors are **not** able to be customized. <
Line 103: Line 105:
  
 **Your own Personal iPhone App** **Your own Personal iPhone App**
-  * Uses the Mobile API addon((The only "difference" within the addon itself is that you would use a special license.)) to allow your personal iPhone app to "connect to" your website.  To get a personal iPhone app, contact us at [email protected] for pricing and to get on the waiting list. <+  * Uses the Mobile API addon((The only "difference" within the addon itself is that you would use a special license.)) to allow your personal iPhone app to "connect to" your website.  To get a personal iPhone app, follow the complete steps above. <
   * App locked exclusively to your site, no needing to enter a site key. <   * App locked exclusively to your site, no needing to enter a site key. <
   * YOU name the app <   * YOU name the app <
Line 113: Line 115:
  
  
-Anyone interested in a personal iPhone app, contact us at [email protected] for pricing.  Currently there is a wait list to get your own personal iPhone app, due to the customizations required to personalize the app.  
addons/mobile_api/start.1331228212.txt.gz · Last modified: 2014/09/25 16:55 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki