© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

AT&T U-verse® Enabled

How to Register and Start Developing for U-verse Enabled

Publication Date: September 9, 2014

Legal Disclaimer

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

i

This document and the information contained herein (collectively, the "Information") is provided to you (both the individual receiving

this document and any legal entity on behalf of which such individual is acting) ("You" and "Your") by AT&T, on behalf of itself and

its affiliates ("AT&T") for informational purposes only. AT&T is providing the Information to You because AT&T believes the

Information may be useful to You. The Information is provided to You solely on the basis that You will be responsible for making

Your own assessments of the Information and are advised to verify all representations, statements and information before using or

relying upon any of the Information. Although AT&T has exercised reasonable care in providing the Information to You, AT&T does

not warrant the accuracy of the Information and is not responsible for any damages arising from Your use of or reliance upon the

Information. You further understand and agree that AT&T in no way represents, and You in no way rely on a belief, that AT&T is

providing the Information in accordance with any standard or service (routine, customary or otherwise) related to the consult ing,

services, hardware or software industries.

AT&T DOES NOT WARRANT THAT THE INFORMATION IS ERROR-FREE. AT&T IS PROVIDING THE INFORMATION TO YOU

"AS IS" AND "WITH ALL FAULTS." AT&T DOES NOT WARRANT, BY VIRTUE OF THIS DOCUMENT, OR BY ANY COURSE OF

PERFORMANCE, COURSE OF DEALING, USAGE OF TRADE OR ANY COLLATERAL DOCUMENT HEREUNDER OR

OTHERWISE, AND HEREBY EXPRESSLY DISCLAIMS, ANY REPRESENTATION OR WARRANTY OF ANY KIND WITH

RESPECT TO THE INFORMATION, INCLUDING, WITHOUT LIMITATION, ANY REPRESENTATION OR WARRANTY OF

DESIGN, PERFORMANCE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, OR

ANY REPRESENTATION OR WARRANTY THAT THE INFORMATION IS APPLICABLE TO OR INTEROPERABLE WITH ANY

SYSTEM, DATA, HARDWARE OR SOFTWARE OF ANY KIND. AT&T DISCLAIMS AND IN NO EVENT SHALL BE LIABLE FOR

ANY LOSSES OR DAMAGES OF ANY KIND, WHETHER DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, PUNITIVE,

SPECIAL OR EXEMPLARY, INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS

INTERRUPTION, LOSS OF BUSINESS INFORMATION, LOSS OF GOODWILL, COVER, TORTIOUS CONDUCT OR OTHER

PECUNIARY LOSS, ARISING OUT OF OR IN ANY WAY RELATED TO THE PROVISION, NON-PROVISION, USE OR NON-USE

OF THE INFORMATION, EVEN IF AT&T HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSSES OR DAMAGES.

Table of Contents

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

ii

Contents

1 Introduction .................................................................................................................................... 1

1.1 Additional Resources ................................................................................................................ 1

2 Register for the Developer Program ................................................................................................. 2

3 Register a U-verse Enabled App ....................................................................................................... 3

4 Enter App Details ............................................................................................................................. 4

5 Enabling the Developer Channel ...................................................................................................... 7

6 About the AAP Bundle ................................................................................................................... 10

7 Further Information ....................................................................................................................... 12

Table of Figures

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

iii

Figure 2-1. AT&T Developer Program registration page. .......................................................................... 2

Figure 3-1. U-verse Enabled Control Panel. .............................................................................................. 3

Figure 4-1. App Details page. ................................................................................................................... 5

Figure 5-1: Manage and Register U-verse Enabled Applications. .............................................................. 7

Figure 5-2: Request Developer Channel. .................................................................................................. 8

Figure 5-3: Submit and Agree to Terms. ................................................................................................... 9

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 1 of 12

1 Introduction

This document outlines the registration process for developing U-verse Enabled apps. The AT&T Developer Program web site enables you to manage all aspects of developing U-verse Enabled apps. With the tool you will be able to create an organization, sign and manage contracts, add developers to an organization, and manage your U-verse Enabled apps.

On the AT&T Developer Program web site, the apps that you build are associated with your organization, which is responsible for each app that you register, as well as developer contracts with AT&T. You can add or remove developers within your organization. If you are an individual developer, you still need to create an organization profile for yourself. For more information about the web site, please see the AT&T Developer Program Website FAQs.

1.1 Additional Resources

In addition to this document, you may find the following documents helpful when developing U-verse Enabled iOS apps:

How to Set Up a U-verse Enabled Project in Xcode

How to Write Your First AT&T U-verse Enabled iOS App

You can find these documents, as well as more technical information, on the AT&T Developer Program web site. To see these documents see the Develop AT&T U-verse ® Enabled Apps and select the development platform that you are interested in.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 2 of 12

2 Register for the Developer Program

To register your organization on the AT&T Developer Program web site, go to developer.att.com and click “Join Now” at the top right corner of the page. On the next screen, enter your name, address, email address and company name. Registration gives you access to the entire family of available AT&T SDKs, including U-verse Enabled.

When you join the AT&T Developer Program, you may either join an existing organization or create an organization. If you choose to join an existing organization, you must wait for your organization’s administrator to approve your application. If you choose to create a new organization, you will need to become a full member of the AT&T Developer Program. For more details on the benefits of full membership, please visit the AT&T Developer Program website. Full membership currently has an annual fee of $99 per organization.

A Developer Profile is required for each developer you wish to add to your organization. Once you have set up your organization profile and added at least one developer, you will be able to register a U-verse Enabled app.

Figure 2-1. AT&T Developer Program registration page.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 3 of 12

3 Register a U-verse Enabled App

1. Open the U-verse Enabled Onboarding Tool.

2. If you are not logged in to the AT&T Developer Program, you will be prompted for your Developer Program user name and password.

3. Read and agree to the legal agreement to access the U-Verse Enabled control panel.

Figure 3-1. U-verse Enabled Control Panel.

4. Click the “Submit a new App” button for first-time submission of an app and also to receive a test Application Authentication Package (AAP) to use when you build and test your app with a U-verse Enabled Receiver. Please see Section 6, About the AAP Bundle for further details on the AAP.

5. You will see an overview of your organization, along will your own details. Click “Next” to advance to the next page.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 4 of 12

4 Enter App Details

The App Details page is where you describe your app and obtain an AAP bundle. An AAP bundle contains a security certificate that is linked to your app. Your app will only be allowed to run in the production U-verse network if the app id and version matches what was requested for the AAP.

1. Enter an App Name. You should use the name that you wish to use in the App Store. Changing the app name after submission could result in a delay in the Application approval process while a new AAP is issued with an updated App Name or Application ID.

2. Enter an Application ID matching the app bundle identifier that you set in Xcode for a project. The Application ID should also be the one you intend to use when you submit your app to the Apple App Store. We recommend that your Application ID be the reverse DNS notation of your company website and the app name. You will need a separate Application ID for each target platform. For example, if you intend to create separate iPhone and iPad versions, you must use separate Application IDs, but if the app is universal to both, you will only need one Application ID.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 5 of 12

Figure 4-1. App Details page.

3. Enter the Version Number of your app. The version number can be either a two part number, for example 1.0, or a three part number, for example 1.0.0. The correct version number is required for your app to function in the production U-verse Enabled environment. Only an exact match of the version number you registered for your app and the app has completed AT&T Quality Engineering Testing will be allowed to run in the U-verse Enabled production environment. For the test environment any version is allowed to run.

4. Enter a Target Launch Date on which you plan to release the app. The date does not have to be firm.

5. Enter an optional App URL. This is the URL of a customer-facing website that you would use to promote the app.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 6 of 12

6. Enter an App Description, including any third-party dependencies or code you may be using in your app, along with a brief description of your app’s functionality.

7. List the U-verse Enabled objects that you intend to use in your code. You do not need to include any of the general objects necessary in every U-verse Enabled Project, such as UverseConnectedManager or SetTopBox, but do provide details of any objects that you use that inherit from uveNode or uveBaseCommand, for example. This section can be left blank when are registered the app details for the first time, but should be completed before you submit your app for AT&T Quality Engineering testing.

8. Click “Next” to review the information you provided, then either go back and edit your App Details or click “Submit.” The Test Certificate (AAP) for your app will be available to download in the “Auth package” section of your app in the control panel within five days. To access the AAP, click the app name on your Overview page and click the “Auth. Package” tab. Once you download the AAP Bundle, you can start testing your app on a testing-enabled U-verse receiver.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 7 of 12

5 Enabling the Developer Channel

Developers who have a consumer U-verse Service, will be able to apply for the U-verse Enabled Developer Channel (9315) to be enabled on their U-verse receiver. In order to test the application that is being developed, only the developer channel (9315) can be used. Apps that have been issued with a test AAP bundle will not be able to run on the regular U-verse Enabled Channel (9301).. The developer channel is not enabled by default on the regular consumer U-verse receiver. In order to enable this channel, follow the steps

1. Enter the U-verse Enabled Onboarding Tool and click “Manage and Register U-verse Enabled Applications”.

2. Select “Company Profile”

Figure 5-1: Manage and Register U-verse Enabled Applications.

3. You will see a summary of your details and the details of the organization that you are associated with. In the bottom right side of the page, click the link “Request Developer Channel”

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 8 of 12

Figure 5-2: Request Developer Channel.

4. In the popup window that appears, enter the U-verse Billing Account Number (BAN) and the email address that is associated with this U-verse account.

5. Click “Submit and Agree to Terms”. By clicking this button, you will be agreeing to the Developer Testing Agreement that is displayed in this popup.

You should read this agreement fully before clicking the submit button.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 9 of 12

Figure 5-3: Submit and Agree to Terms.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 10 of 12

6 About the AAP Bundle

The AAP (Application Authentication Package) bundle is a zip file that contains resource files including your Application Certificate and your Developer Key. The resource files differ depending on whether your app is certified for a development environment or a production environment. After you submit your app information to the U-verse Enabled Onboarding Tool, the test AAP bundle will be available to download from the “Auth Package” section, and after your app passes AT&T Quality Engineering testing, production resource files will be available.

Note: Version 5.0 and later of the U-verse Enabled SDK use a new version of the

AAP bundle. This new version of the AAP bundle is not compatible with earlier versions of the U-verse Enabled SDK. However, the existing AAP bundles will continue to function with apps which are built using the 3.x version of the U-verse Enabled SDK and earlier. An updated bundle is created when you create or update an app and select version 5.0 of the U-verse Enabled SDK in the U-verse Enabled onboarding tool. The updated AAP bundle is valid for ten years, an improvement over the previous bundle’s two-year lifespan.

The same AAP files can be used in new versions of an app. However, version number changes must be registered with AT&T through the U-verse Enabled Control Panel in the U-verse Enabled Onboarding Tool for the production environment. All new versions of the app will be required to undergo AT&T Quality Engineering testing before a new version may run in production. More information on the submission process can be found on the submission page, see the Submit AT&T U-verse Enabled Apps page on the AT&T Developer Program Web site.

The test AAP bundles for ZDEV do not include version checking, and as such the version number can be changed during development. The version number is checked in the production environment and the CFBundleShortVersionString (or the build number in Xcode) must exactly match the version number that is registered in the U-verse Enabled Onboarding Tool.

The AAP resource file and the AAP Developer Key are necessary to associate your app with a U-verse receiver (set-top box).

The resource bundle file name ends with the extension “.resource,” and the developer key file name ends with the extension “.satoken”. Both file names are prefixed with the bundle identifier, version number, and the environment that the files are issued for. You must use the correct AAP Bundle for each environment, and using the wrong AAP bundle will cause your app to fail with an Internal U-verse error code 3000.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 11 of 12

For example, files for an app named “ExampleTestApp” version 1.0 in a test environment will be in the bundle “com.example.ExampleTestApp”, and the file names will include “com.example.ExampleTestApp.1.0.testca.resource” and “com.example.ExampleTestApp.1.0.testca.satoken”.

There are two different types of AAP bundles that could be issued.

Production – This AAP will be issued after your app completes AT&T Quality Engineering testing. Every version update will need to be submitted to AT&T for testing before the version is allowed to run in the production environment. The AAP bundle will contain the environment name prodca.

ZDEV – This is a test environment that can be used to test your application. This environment can be accessed through the U-verse Enabled Developer Test Channel (9315). If you have a consumer U-verse account, you can apply for this channel to be enabled on your U-verse receiver through the U-verse Enabled Onboarding Tool. The details of this are covered in Section 5, Enabling the Developer Channel. The AAP bundle will contain the environment name zdevca.

When you use the developer channel (9315) for your testing, you must first tune your receiver to the developer channel before testing. As these U-verse receivers will have two different U-verse Enabled environments, production and ZDEV, the U-verse receiver will attempt to authenticate your app with the environment that was last used.

If the last used environment was the production environment (channel 9301), and you are trying to run an app with a ZDEV AAP, engagement with a receiver will fail. If you tune the receiver to the developer channel (channel 9315), and restart your app, it will then succeed.

This is also the case if you are testing an app in the ZDEV environment, and then want to run an app in the production environment, i.e. an app that was downloaded from the App Store, you will first need to tune the U-verse receiver to channel 9301 before the app will be able to engage with the U-verse receiver.

This Developer Key is a shared secret and should be kept private. Your app must pass the key to the UverseConnectedManager object before calling startDiscovery.

© 2014 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.

Page 12 of 12

7 Further Information

For more information on developing your first U-verse Enabled app, as well as sample code, see Develop AT&T U-verse Enabled Apps and select the development platform that you are interested in.