API Platform IA v8.0sueannharkey.com/wordpress/wp-content/themes/... · create or join an OP to give access to the new API Platform or „Free Trail‟.-A T& erms o fU: M ay hv n

Page 1 of 25

Information Architecture

User Types and Status- Developers

API Platform

Last Modified 8/3/2011 iSoftStone

API_Platform_IA_v8.0.vsdAPI Platform

Sue Ann Harkey

Subscriber

AT&T Admin

AT&T Support Agent

ANONYMOUS/NOT SIGNED-IN Lite REGISTERED (DEV PROGRAM) ASSOCIATED TO OP (JOIN OP)OP ADMIN

Registration on

developer

program site

DEV-A DEV-DDEV-B

‘Registered’

Registered on Developer Program site

Variations include:

- Registered & signed-in with „general‟ access

- Registered & signed-in with „special‟ access

Additional content available to DEV-B:

- Manage My Account

- Developer Dashboard

- API PLATFORM Link (NEW)

Congratulations

an email was

sent

EMAIL:

Please click the

following URL to

verify your email

address:

Choose a

Password

Congratulations

successfully set

your password

‘Associated to OP’

Joined an existing OP

Additional content available to DEV-D:

- Manage My Account


Admin needs to assign privileges:

- Allowed to purchase Platform Offer

- Allowed to send App to Production

- Allowed to view other DEVs Apps

Find

Existing OP

Submit request to

Join OP

DEV-C

‘OP Administrator’

Created the OP

Additional content available to DEV-C:

- Manage My Account


Content becomes available to DEV-E:


System

sends confirm

email address

email to devSystem

sends OPA

and dev-E

email

Developer

Program Home

Content available to ALL DEV-A:

- Home

- Join Now - Registration

- Manage My Account

- Program Features

- Developer Dashboard Link

- API Landing (NEW)

- API Catalog Home (NEW Page)

- API Category Page (default on Information Tab) (NEW Tab Page)

--- API Category Page (Technical Tab)

--- API Category Page (Business Tab)

- Guidelines (NEW Page)

- Roadmap (NEW Page)

- API Platform (NEW)

- Devices

- Community (+ NEW API Platform content)

- Blogs

- Events

- Forums

- Newsletters

- Learn (+ NEW API Platform content)

- Platforms & OSes

- Network technologies

- Enterprise Reference Library

- Enabling Technologies

- Develop (+ NEW API Platform content)

- SDKs

- Innovation with Network Services

- References & Tutorials

- UI design Principles

- Launch (+ NEW API Platform content)

- Launch through AT&T

- Distribution to Customers

- Mobil Marketing

- Distribution to Businesses

- Support (+ NEW API Platform content)

- FAQs

- Tech Tips

- Live Chat

- Footer Links

Registration Process:


submitted

„set password‟

Notes

-Registering on the Developer Program site is a pre-requisite to creating Merchant Accounts for DEVs C, D, E

- Strike through text items is content not visible to DEV

- All DEV could hold Device or Network Services roles

Admin accepts

request and sets

privileges and sends

email to dev-E

Search

Organizaion

Enter Org. Info

Set up Merchant

Account

Enter Payment

Method

Review Order

and Submit

Sign In

Dev receives email

that OP is

accepted clicks link

in email to sign in

Developer

Program Home

Content becomes available to DEV-C:

- Admin Controls – Account Management



Dev receives email that

OPA has accepted their

Join Request clicks link

in email to sign in

Sign In

‘Anonymous’

Not registered or signed-in on

Developer Program site

Variations of ‘Anonymous’ Cookies include:

- First time on site – Non-Registered

(no cookie)

- Returned to site – Non-Registered

(„return visitor‟ cookie)

- Lite Registered - not signed-in

(„lite registration‟ cookie)

- OP Admin Registered with access to API Platform

– not-signed-in („OP Admin‟ with access cookie )

- OP Admin Registered without access to API Platform

– not-signed-in („OP Admin‟ no access cookie )

- Joined OP Registered – not-signed-in

(„Joined OP‟ cookie)

Both AT&T User

Types are known as

„Back office‟.

- AT&T „Support

Agent‟ to manage

Developer Support

help ticket inquiries

- AT&T Admin to

manage Compliance

situations

Link to

API Platform

Link to

API Platform

Create/Join OP?

Yes

„Guest Pass‟?

Yes

„Guest Pass‟?

Yes

„Guest Pass‟?

Yes

Validate OP

account

Congrats,

Check Email

Page 2 of 25


Developer Program Sitemap

API Platform



Sue Ann Harkey

Signed in displays

Dashboard link

Create an OP

Join an existing OP

Existing Join flow

Choose a

Password

Home

Developer

Program

Search for

Organization

Enter Payment

Method

Congrats,

Check email

Congrats – you

have joined,

check for email

Join NowProgram

Features

Manage My

Account &

Acct Settings

-----------------

Account Info

Tab (default)

Devices Community SupportLaunchDevelopLearnAPI Landing

Congrats – you

have set

password

Sign in

to access API

platform

Search for

Organization

(OP found)

Review OP

Almost Done,

Check email

API Category

-----------------

Introduction

Tab

API Catalog

Landing

(All APIs)

Blogs

Events

Forums

Newsletter

Platforms &

OSes

Network

Technologies

Enterprise

Reference

Library

Enabling

Technologies

SDKs

Innovation with

Network

Services

References &

Tutorials

UI design

principles

Launch through

AT&T

Distribution to

Customers

Mobile

Marketing

Distribution to

Businesses

FAQs

Tech Tips

Live Chat

Footer Links

AT&T

Intellectual

Property

Contact UsSite MapAT&T Terms

of Use

White Background = existing pages always accessible

Blue Background = NEW pages visible when signed-in at an OP or

associated to an OP level

Sitemap Key

Community

Profile

Tab

Compare

Devices

Organization

Profile

Tab

Pink Background = existing pages accessible when signed-in at a member to

the Developer Program site level

Thick red outline = New Pages added to support the new API Platform Offer

Orange solid outline = pages that will have changes. Changes include adding new content

regarding the new service offering „API Platform‟

About New Content and new pages regarding the API Platform added to the Developer Program site

Pages with solid outlines in Orange indicate changes to existing pages by adding new content

that supports the new API Platform offer in iSoftStones wireframes. A dashed orange outline

indicates that new content is assumed will be added, TBD.

- Home: Add up-sell blurbs about Guest Pass and API Platform offering. These blurbs will link to

the new page, API Platform which will include promo for „Guest Pass and info about Registration

to get them started. Which Registration process they are redirected to will be based on their

cookies.

- Program features: Add descriptions about new API Platform offering and add link to Guest

Pass.

- Developer Dashboard: Adding new content to support access to the new API Platform.

INcludes Dev compliance messaging and alerts.

- Community: Community and all the pages in this section may begin to have content regarding

the new API Platform offer. Either user generated or added blurbs from AT&T content

managers. TBD.

- Learn: Learn and all the pages in this section may have content regarding the new API

Platform offer. TBD.

- Develop: Develop and all the pages in this section may have content regarding the new API


- Launch: Launch and all the pages in this section may have content regarding the new API


- Support: Support and all the pages in this section may have content regarding the new API


- Manage My Account: Addition of TABs to accommodate new API Platform needs:

--- Administration controls for setting OP member privileges

--- Purchasing, renewing, and upgrading API Platform access subscriptions

--- Management of payment methods (edits and add new)

- Congratulations you have set password: Added „Benefits to API Platform‟ content and call-

to-action on this screen after finishing a „Join Developer Program‟ journey to continue now to

create or join an OP to give access to the new API Platform or „Free Trail‟.

- AT&T Terms of Use: May have new content regarding the new API Platform offer. TBD.

- Site Map: Need to add all new API Platform pages added.

Pages filled in with red outline are NEW pages added to the site to support the integration of the

new API Platform and is accessible to all.

- API Landing: Marketing opportunity for describing new API offering, Catalog, and Guest Pass.

- API Catalog Home: „Catalog Home‟ page content that lists and describes each API offer and

showcases the Call-To-Actions through-out the catalog screens. Its access through a new link in

the global nav under the section „API Landing‟ and is accessible to all.

- API Catalog API Detail: Each API is thoroughly described on its „Detail‟ page.

- API Catalog Standard Roadmap: AT&T descriptions of future API releases.

- API Platform: A marketing page that provides a link to access the API Platform environment and

may includes Call-To-Actions prompting the user to either enter the „Guest Pass or to „Get Started‟

by creating or joininig an OP to gain access to the new API Platform. This screen can act as the

landing page for Call-To-Action links peppered through-out the site. Accessed via a link in the

global nav under the section „API Landing‟ and is accessible to all.

- Sign-in, join or create an OP: This is an interrupt sign-in screen that displays as part of the Call-

To-Action journeys (if any) and acts as the sign-in prompt when a user needs to sign-in to access

the API Platform environment. Similar to the time-out log-in prompt when on locked content. It is

also a marketing opportunity to incentivize creating an OP to access the API Platform.

- Free Trail: TBD. Not a page per-say but access to the „Guest Pass‟. Our recommendation is an

experience similar to Apigee‟s Guest Pass.

- Create or join an Organization Profile: The „Registration‟ process to either Create or Join an

existing OP. New follow through links are added to the „Congratulations‟ screen at the end of the

„Join‟ Developers Program site registration. This journey can also begin through the Call-To-Action

links via the „About the API Platform‟ marketing screen. At the end of this process access to the

API Platform global nav link becomes available upon sign-in. Similar to access to the Developer

Dashboard link in the global nav.

Pages filled in Blue are new pages added to the site to support the integration of the new API

Platform. They are accessible only after a user who has created or joined an OP has signed-in.

- Manage My Account: Organization Profile TAB: This is where an OPA will manage their

members and privileges.

- Manage My Account: Billing Information TAB: This is where an OPA will manage their

merchant account details, Bank Account, Credit Cards and add new payment methods.Orange dashed outline = existing pages that MAY have new content changes. TBD from

AT&T review. (See „About New Content‟ comments to the right.)

Billing

Information

Tab

Account Tab screens

These content

sections will manage new

content for the new API

Platform offering

NEW API Platform Sign-in prompt

existing

Sign-in prompt

Time-out Sign-in

Roadmap

Guidelines

Sorry don‟t have

access to

platform

Don’t have Access screen

Enter

Organization

Information

Set up merchant

account

Select Access,

Agree to TofC

Shopping Cart

Select Access,

Agree to TofC

Review and

Submit

Congrats,

Check email

Enter Payment

Method

Developer

Dashboard

-----------------

Get Started

Tab

Dashboard Tab screens

New API content in

Dashboard will manage:

- Dev Compliance alerts and

messaging

- Default Tab is dynamic

depending on users status TBD

- „Go to API Platform‟ button

conditionally display for with

Access only and redirects to

„My Page‟. Button displays as

„Get Started‟ is user does not

have access to API Platform

and redirects to „Search OP‟

and takes user down the

registration process.

View API

Reports

Tab

View

AppCenter

Reports Tab

Manage Apps

& Devices

Calls Tab

Business Tab

API Category Tab screens

API Catalog pages

New API Platform pages

Global Nav Dropdown links:

- API Landing (top global link)

- API Catalog Home

- API Platform (access to Blackflag)

Catalog Left Hand Nav links:

- Catalog Home (All APIs)

- API Category (Intro, Calls, Tech, Business tabs)

- Guidelines

- Roadmap (TBD)

New Acct screens

will manage:

- Admin controls for

setting OP privileges

- Purchase access to

API Platform reminder

- Managing payment

methods

- Purchase History

Review and

Submit

New „View API Reports‟

Tab is Conditional:

- IF user has Access to API

Platform tab is clickable and

displays in enabled state

- IF user does not have

Access, tab displays in

grayed back enactive state.

API Platform

(access page)

Technical Tab

New API Platform: TBD

- Is an option in the global

nav dropdown

- Access to the API Platform

is through this screen

- This screen might replace

the „API Platform „Sign-In‟‟

screen in far right of this

sitemap

Page 3 of 25


Global Navigation studies

API Platform



Sue Ann Harkey

Not Signed-In:

Dashboard:

- Adding ability to access

API Platform screens from

Dashboard screens

- Added new section to global

header links „API Landing‟

(working title)

Pages under section:

- API Landing page

- API Catalog Home page

- API Category (Tabs page)

- Guidelines

- Roadmap TBD

- API Platform page

Signed-In:

Page 4 of 25


API Platform Sitemap

API Platform



Sue Ann Harkey

My Page

API

(Request/

Response)

Documentation SDKs Help

Guest Pass TBD

View Your

AccountSearch Results

Set up a new

App

App Detail

Modify

Shortcuts

(dialog box)

Edit App

Delete App

Sandbox

API Key

Production

API Key

Request

Production

Access

White Background = existing API Platform screens

Sitemap Key

Developer Program portal

Thick red outline = Guest Pass TBD

Guest Pass

Access links from the

Developer Program site

has redirects to:

- „My Page‟

- „API Console‟

- „Documentation‟

Developer

Program

Site

Page 5 of 25


Access points to API Platform - Sitemap

API Platform



Sue Ann Harkey

Program

FeaturesAPI Landing

API Category

-----------------

Introduction

Tab

API Catalog

Landing

(All APIs)

Roadmap

Guidelines

Developer

Dashboard

-----------------

Get Started

Tab

Signed-In Dashboard Tab screens

View API

Reports

Tab

View

AppCenter

Reports Tab

Manage Apps

& Devices

Calls Tab

Business Tab

API Category Tab screens

API Catalog pages

API Platform

(access page)

Technical Tab Create an OP

Join an existing OP

Existing Join flow

Choose a

Password

Home

Developer

Program

Search for

Organization

Enter Payment

Method

Congrats,

Check email

Congrats – you

have joined,

check for email

Join NowManage My

Account &

Acct Settings

-----------------

Account Info

Tab (default)

Devices Community SupportLaunchDevelopLearn

Congrats – you

have set

password

Sign in

to access API

platform

Search for

Organization

(OP found)

Review OP

Almost Done,

Check email

Blogs

Events

Forums

Newsletter

Platforms &

OSes

Network

Technologies

Enterprise

Reference

Library

Enabling

Technologies

SDKs

Innovation with

Network

Services

References &

Tutorials

UI design

principles

Launch through

AT&T

Distribution to

Customers

Mobile

Marketing

Distribution to

Businesses

FAQs

Tech Tips

Live Chat

Community

Profile

Tab

Compare

Devices

Organization

Profile

Tab

Billing

Information

Tab

Account Tab screens

NEW API Platform Sign-in prompt

existing

Sign-in prompt

Time-out Sign-in

Sorry don‟t

have access to

platform

Don’t have Access screen

Enter

Organization

Information

Set up

merchant

account

Select Access,

Agree to TofC

Shopping Cart

Select Access,

Agree to TofC

Review and

Submit

Congrats,

Check email

Enter Payment

Method

Review and

Submit

API Platform Tier 1

My Page

API

(Request/

Response)

Documentation SDKs HelpView Your

Account

Signed-In as

OP with access

ASSUMPTIONS

- Access to Platform requires:

--- Organization Profile

--- Has Purchased Access

--- Signed-In

Sitemap Key

Pages with access

to API Platform

Upon completion of OP registration with access

Signed-In OP

with access

Clicks on link

„Go to API Platform‟

Signed-In OP

with access

Clicks on link

„Go to API Platform‟

Clicked on

„Documentation‟

link

Clicked on

„API Console‟

link

Clicked on

„My Page‟

link

Unsigned-in

Clicks on

„Get Started‟

or

„Go to API

Platform‟

Page 6 of 25


API Landing section global nav and flows

API Platform



Sue Ann Harkey

Global Header

Why AT&T APIs

3 Steps to Getting Started

„Guest Pass‟ TBD

Global Footer

(1)

Register

(2)

Develop(3)

Deploy

View all APIs

Get Started

Featured API

Payment

View Details

Go to API Platform button

NEW API Section var A

API Landing Dropdown options

o API Landing (Global NAV link to marketing page modeled after the

home page template)

· API Catalog (Catalog Home page default = ‘All API)

· API Platform (access to API Platform screen)

Catalog Pages

API Landing

page

R1 release: API Catalog Left Hand Nav

· All APIs (Catalog Home page)

· Contacts (API Category Tab page)

· Device (API Category Tab page)

· Location (API Category Tab page)

· Multimedia Messaging Service(MMS) (API Category Tab page)

· Payment (API Category Tab page)

· Short Messaging Service(SMS) (API Category Tab page)

· Speech (API Category Tab page)

· Wap Push (API Category Tab page)

· Guidelines (generic content TBD)

· Roadmap (Editorial/mrkt page TBD)

API catalog

home page

API Category

Tab page

Roadmap

page

Guidelines

page

API Landing page

Search for

OrganizationJoin

(Lite Reg)

Anonymous

clicked on „Get Started‟

Lite Reg only

API Catalog

home page

API Category

Intro Tab page

API Platform

Sign-In screen

Not Signed-In

API Platform

(Blackflag)

My Page

Submits „Sign-In‟

Upon completion of

OP registration

and purchase of access

redirects to

API Platform

Upon completion of

OP registration

and purchase of access

redirects to

API Platform

Search for

Organization

Continues to

OP Creation

API Platform

access page

Go to API Platform

API Platform

(Blackflag)

My Page

Signed-In

API Platform

(Blackflag)

My Page

Text links in „Steps to Get

Started‟ copy can redirect

to various locations on the

Developer Platform portal:

- Registration = „Join Now‟

- Develop = „Develop‟ TBD

- Deploy = „Launch‟ TBD

API Platform

Go to API Platform

API Catalog

Signed-In with access

View all APIs

Page 7 of 25


API Landing page as top Global Nav link and dynamic Sign-In to API Platform flows

API Platform



Sue Ann Harkey

Dynamic API Platform Sign-In Module

API Landing page (not Signed-In)

Go to the API Platform

Click on the button to

go to your API Dashboard

API Platform

(Blackflag)

My Page

API Landing page (Signed-In)

Go to API Platform

Join

(Lite Reg)

Lite Reg only

has OP and

access

Sign InNot a member of the AT&T

Developer Program yet?

Join Now.

Forgot your username or password?

Already a member of the API

Platform? Please sign in to go

to the platform now.

Username

Password

clicked on „Join Now‟

Anonymous

Lite Reg onlySearch for

Organization

Finishes OP registration

and purchases access to API Platform

Lite Reg only

Global Header

Why AT&T APIs

Featured APIs

Global Footer

View all APIs

View all APIs

API Support

View API Support

Global Header

Why AT&T APIs

3 Steps to Getting Started


Global Footer

(1)

Register

(2)

Develop(3)

Deploy

View all APIs

Payment API

Details

Location API

Details

Speech API

Details

API Landing page – Not Signed-

In state:

- Dynamic Content per-Signed-In

status

- Not Signed-In displays „Sign-In

Module‟ with Sign-In fields

- Promo Links to API Catalog

- Featured New API Promo

opportunity

- Steps to Access API Platform

Get Started

Featured API

Payment

View Details

API Landing page as top link in

Global Nav – Signed-In state:

- Dynamic Content per-Signed-In

status

- Signed-In displays „Sign-In

Module‟ as button to access

API Platform (goes to My Page)

- Promo Links to Featured New

API „Category page in Catalog

- API Catalog promo link

- Steps to Access API Platform

Page 8 of 25


Various flows to the API Platform

API Platform



Sue Ann Harkey

Access to API Platform after create OP without access

API Landing

Finish of Lite Reg,

clicks on „Learn More‟

API Landing

Finish of create OP,

clicks on „Learn More‟

Shopping Cart

Select Program

Has OP but not Access,

clicks on „Get Started‟

Congrats – you

have set

password

Select Access,

Agree to TofC

Manage My

Account

API Platform

(Blackflag)

My Page

Finish of OP Reg,

clicks on „Get Started‟

Finish of Lite Reg,

clicks „Continues‟ to

Create an OP

Search for

Organization

API Platform

(Blackflag)

My Page

Finish „Shopping

Cart‟ gets access

to API Platform

Access to API Platform after Lite Reg Access to API Platform from Manage My Account with no Access

Has Access,

clicks on „Go to API Platform‟

Manage My

Account

API Platform

(Blackflag)

My Page

Access to API Platform from Manage My Account with Access

Access to API Platform from any ‘Get Started’ button by a Signed-In member of an OP without access

Clicked on

„Cancel‟

Get Started

Sorry don‟t

have access to

platform page

Clicked on any

„Get Started‟ button

Clicked on

„Guest Pass‟

API Platform

(Blackflag)

Guest Pass

TBD

Goes back to

original location

Access to API Platform from any ‘Get Started’ button (by an anonymous user)

Get Started

Sign in

to access API

platform

Clicked on any

„Get Started‟ button

Has OP Access

Clicked on Sign-In

API Platform

(Blackflag)

My Page

Clicks on

„Join Now‟

Search for

Organization

Join

(Lite Reg)Anonymous

Lite Reg only

API Platform

(Blackflag)

My Page

Finish OP

with access

Page 9 of 25

| WireframesAPI Landing page study var-A

API PlatformSue Ann Harkey


API_Platform_IA_v8.0.vsd

API Platform

Global Footer

Why AT&T APIsOur APIs are the next great evolution in mobile development at AT&T. View our full offering and get all the details you need to develop with our suite of robust API‟s to reach our 90 million AT&T customers.

3 easy steps to get startedwith the AT&T API Platform

1Register 2Develop 3

Featured APIs

Ut wisi enim ad minim veniam, quis nostrud exerci tation Join Now suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel API Landing dolor in

hendrerit in vulputate.

Ut wisi enim ad minim veniam, quis nostrud exerci tation Join Now suscipit Develop nisl ut aliquip ex ea commodo consequat. Duis autem vel API Landing dolor in hendrerit in vulputate. Lobortis nisl ut aliquip

enim ad minim veniam.

Ut wisi enim ad Launch veniam, quis nostrud exerci tation Join Now suscipit Develop nisl ut aliquip ex ea commodo consequat. Duis autem vel API Landing dolor in

hendrerit .

PaymentDuis autem vel eum iriure dolor in hendrerit

in vulputate velit esse molestie consequat

View Payment API details

API Catalog

All APIsDuis autem vel eum iriure dolor in hendrerit in

vulputate velit esse molestie consequat

Deploy

View all APIs


API Landing

API Catalog

API Platform

Home > API Landing

LocationDuis autem vel eum iriure dolor in hendrerit


View Location API details

SpeechDuis autem vel eum iriure dolor in hendrerit


View Speech API details

Get Started

API Landing

API Catalog

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Guidelines

Roadmap

API Platform

Example of a possible

Left Hand Nav for the new

API section.

This shows what it would

look line while on the AI

Catalog home page.

Page 10 of 25

| WireframesAPI Landing page study var-B




API Platform

Global Footer




1Register

Ut wisi enim ad minim veniam, quis nostrud exerci tation Join Now suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel API Landing dolor in hendrerit in

vulputate.

Get Started

2Develop

Ut wisi enim ad minim veniam, quis nostrud exerci tation Join Now suscipit Develop nisl ut aliquip ex ea commodo consequat. Duis autem vel API Landing dolor in hendrerit in vulputate. Lobortis nisl

ut aliquip enim ad minim veniam.

3Ut wisi enim ad Launch veniam, quis nostrud exerci tation Join Now suscipit Develop nisl ut aliquip ex ea commodo consequat. Duis autem vel API

Landing dolor in hendrerit .

Deploy

API Catalog

Duis aute irure dolor in reprehenderit

in voluptate velit esse cillum dolore

eu fugiat nulla pariatur.

View all APIs

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Services Include

Page 11 of 25

| WireframesAPI Landing page study var-C




API Platform

Global Footer



1RegisterFeatured APIs


vulputate.

PaymentDuis autem vel eum iriure dolor in hendrerit


View Payment API details

LocationDuis autem vel eum iriure dolor in hendrerit


View Location API details

SpeechDuis autem vel eum iriure dolor in hendrerit


View Speech API details

Get Started

2Develop





Deploy



Join Now.





Username

Password

View all APIs

Page 12 of 25

| WireframesAPI Landing page study var-D1




API Platform

Global Footer



1Register


vulputate.


Get Started

2Develop





Deploy




Go to API Platform

DeviceUt wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper

suscipit lobortis.

Details

MMSUt wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis.

Details

PaymentDuis autem vel eum iriure dolor in

hendrerit in vulputate velit esse.

Details

SMSUt wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis.

Details

WAPUt wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper

suscipit lobortis.

Details

ContactsDuis autem vel eum iriure dolor in

hendrerit in vulputate velit esse.

Details

SpeechDuis autem vel eum iriure dolor in hendrerit in vulputate velit esse.

Details

LocationDuis autem vel eum iriure dolor in hendrerit in vulputate velit esse.

Details

Our API Services

API Catalog



View all APIs

Page 13 of 25

| WireframesAPI Landing page study var-D2




API Platform

Global Footer



1Register


vulputate.


Get Started

2Develop





Deploy

Contacts

Device




Go to API Platform

Our API Services

API Catalog



View all APIs

Location

MMS

Payment

SMS

Speech

WAP Push

Page 14 of 25

| WireframesAPI Landing page study - as catalog home - var-E




API Platform

Global Footer


Get Started

2Develop

Ut wisi enim ad minim veniam, quis nostrud exerci tation Join Now suscipit Develop nisl ut aliquip ex ea commodo consequat. Duis autem vel API Landing dolor in hendrerit in vulputate. Lobortis nisl ut aliquip enim ad

minim veniam.

3Ut wisi enim ad Launch veniam, quis nostrud exerci tation Join Now suscipit Develop nisl ut aliquip ex ea commodo consequat. Duis

autem vel API Landing dolor in hendrerit .

Deploy



Join Now.





Username

Password

3 easy steps to get started

1Register


vulputate.

DeviceDevice Capabilities returns the characteristics of a given device. Developers can use the service to return model, brand, screen size, MMS support and other device

attributes.

Details

MMSMultimedia Messaging Service (MMS) extends SMS capabilities to include multimedia content. Developers can use MMS to send and receive larger messages than those sent by SMS. Messages can include video, images, text, audio, and Synchronized Multimedia Integration Language (SMIL) formatting

Details

PaymentUt wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie

consequat.

Details

SMSShort Message Service (SMS) allows the exchange of short text messages (160 characters) between mobile phone devices and applications like (e.g., Skype, and AIM) as well as fetch delivery status. Developers can use AT&T‟s SMS Network Service to transmit and receive text messages to create or add text messaging capabilities to their applications.

Details

WAPWAP Push enables messages to be sent to WAP enabled devices equipped with WAP software (commonly a WAP browser) Developers can use the WAP Push service to send messages and alerts that deliver rich content, such as images and audio. WAP Push was defined in the WAP 1.2 standard to provide a method to allow WAP content to be pushed to mobile devices, via a message that includes

a link to the WAP address.

Details

ContactsDuis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo

consequat.

Details

SpeechSpeech Translation accepts an inbound audio file and converts the audio file to text. The Speech Service allows developers to develop applications that require applications to interpret language, acoustics, grammar. Developers can use four (4) application packages that provide generic support for voicemail transcription, local business search, question/answer, and web search.

Details

LocationShort Message Service (SMS) allows the exchange of short text messages (160 characters) between mobile phone devices and applications like (e.g., Skype, and AIM) as well as fetch delivery status. Developers can use AT&T‟s SMS Network Service to transmit and receive text messages to create or add text messaging capabilities to their applications.

Details

API Catalog

Page 15 of 25

| WireframesAPI Landing page study - as catalog home - var-F




API Platform

Global Footer

API Catalog

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Guidelines

Roadmap

API Platform

API Catalog

Get Started

2Develop

Ut wisi enim ad minim veniam, quis nostrud exerci tation Join Now suscipit Develop nisl ut aliquip ex ea commodo consequat. Duis autem vel API Landing dolor in hendrerit in vulputate. Lobortis nisl ut aliquip enim ad

minim veniam.

3Ut wisi enim ad Launch veniam, quis nostrud exerci tation Join Now suscipit Develop nisl ut aliquip ex ea commodo consequat. Duis

autem vel API Landing dolor in hendrerit .

Deploy

3 easy steps to get started

1Register


vulputate.



attributes.

Details

ContactsDuis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip

ex ea commodo consequat.

Details


Details




Go to API Platform

PaymentUt wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit

esse molestie consequat.

Details


Details


Details

WAPWAP Push enables messages to be sent to WAP enabled devices equipped with WAP software (commonly a WAP browser) Developers can use the WAP Push service to send messages and alerts that deliver rich content, such as images and audio. WAP Push was defined in the WAP 1.2 standard to provide a method to allow WAP content to be pushed to mobile devices, via a message that includes a

link to the WAP address.

Details


Details

Page 16 of 25

| WireframesCatalog Home - 7/27




API Platform

Global Header

Global Footer

Home > API Landing > Catalog Home

API CatalogOur API Catalog is the next great evolution in mobile development at AT&T. As a subscriber, you‟ll have access to AT&T Network Service APIs and a first-rate set of tools and process including a robust "sandbox" environment ; carrier-billing; simple on-boarding process with detailed reports about Network Service API usage and app purchases.

Image

Products

All API

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Guidelines

Roadmap


attributes.

Details


Details

PaymentUt wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie

consequat.

Details


Details

WAPWAP Push enables messages to be sent to WAP enabled devices equipped with WAP software (commonly a WAP browser) Developers can use the WAP Push service to send messages and alerts that deliver rich content, such as images and audio. WAP Push was defined in the WAP 1.2 standard to provide a method to allow WAP content to be pushed to mobile devices, via a message that includes

a link to the WAP address.

Details

ContactsDuis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo

consequat.

Details


Details


Details


Feature API

PaymentDuis autem vel eum iriure dolor in hendrerit in


View Payment API details >

Page 17 of 25

| WireframesCatalog - SMS - Introduction Tab 7/27




API Platform

Global Header

Global Footer

Introduction Technical Business

Home > API Catalog > SMS

Products

All API

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Guidelines

Roadmap


Steps to Getting Started

SMS API is exposed in the following multiple formats to enable different types of clients.

· JSON

· JSONP

· XML

· GSMA OneAPI 2.0

The below table lists GSMA OneAPI 2.0 REST API methods supported by current version of AT&T

SMS APIs

Short Message Service (SMS) allows the exchange of short text messages (160 characters) between mobile phone devices and applications like (e.g., Skype, and AIM) as well as fetch delivery status. Developers can use AT&T‟s SMS Network Service to transmit and receive text messages to create or add text messaging capabilities to their applications.

The Short Messaging (SMS) REST API enables applications to send and check delivery status of SMS messages from the network. This API also allows applications to receive SMS messages by polling for them.

SMS

URL Structure

Each URL in the API is structured as follows:

/ {api name}/ [{version}]/ {collection}| {resource}/…

In other words, the URL consists of three basic parts:

1. API Name. The name of the APIs defined. For example, “SpeechSerivce”

2. Version Number: An optional input, which specifies a particular version of the API. If it is not included,

then the “current”version of the API is used, where the current API is modified over a period of time by the

API team. Current version of the API is “1”.

3. Collection and Resource: The collections and resources that make up the API, which are defined for

each API. In this API, the inbox and outbox are the resources

An Example of URL structure for voice mail – speech to text is: /1/SpeechService/VoiceMail/SpeechToText

Response Format Handling

Response Format for the API is determined using Accept-Encoding header in the HTTP Request message.

The following table lists the supported Accept-Encoding header values:

Accept-Encoding Header Response Format

application/json Provides response message in JSON format.

application/xml Provides response message in XML format.

application/json along with Provides response message in JSONP format.

query parameter of "callback

<javascript method>

Get Key

Get Key

„Get Key‟ can be yet

another „access‟ point to

the API Platform. In

Blackflag „Keys‟ are given

after submitting the „set up

a new app‟ page. TBD

Calls

If tables matrix is

used in catalog

can make „Calls‟ a

link to their „Calls‟

tab or to their

„Technical‟ tab

locations.

Page 18 of 25

| WireframesCatalog - SMS - Calls Tab 7/27




API Platform

Global Header


Products

All API

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Guidelines

Roadmap


SMS

Send a SMS Message

Check SMS Delivery Status

Create SMS notification

Delete SMS notification

Receive SMS

Register for SMS Push

Delete SMS Push

Send a SMS Message This API enables the applications to send a SMS message. The messages are processed synchronously and sent asynchronously to the destination. A unique identifier is returned in the response and this can be used to query the status of the SMS sent.

View Technical details

Introduction Technical BusinessCalls


Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis.



At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi tempore, cum soluta nobis est eligendi.



Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.


Receive SMS

Commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.



Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus.


Delete SMS Push

Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur.


Page 19 of 25

| WireframesCatalog - SMS - Technical Tab 7/27




API Platform

Global Header


Products

All API

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Guidelines

Roadmap


SMS

Send a SMS Message




Receive SMS


Delete SMS Push

Send a SMS Message

This API enables the applications to send a SMS message. The messages are processed synchronously and sent asynchronously to the destination. A unique identifier is returned in the response and this can be used to query the status of the SMS sent.

Outbound SMS MessagesThis interface allows the user to operate on the outbox resource. It sends SMS messages and receives the status of messages sent through an asynchronous request. Each time one API call is invoked for sending a single SMS message.

RequestInput ParametersThe following table lists the input parameters.

In this case, all the parameters have to be assembled according to HTTP form-encoding standards with delimiter of “&”. The complete string has to be URL encoded. Form –Encoding format supports adding the address parameter multiple times to support sending SMS to more than one destination.

Form Encoded

The following is a sample response in form-encoded format.

{“address=tel%3A%2B13500000991&

message=Hello%20World”}

In this case, all the parameters have to be assembled according to JSON specification.

JSON


Page 20 of 25

| WireframesCatalog - SMS - Business Tab 7/20 (need content)




API Platform

Global Header


Home > API Catalog > Contacts

Products

All API

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Guidelines

Roadmap

Contacts

Use Cases

Contact Management is an Address Book service that supports two types of entities, a Contact and a Group. Groups are organized contacts, whereas a contact may be associated to one or more groups. The Contact Management Service provides developers the tools to create, retrieve, delete and update contacts and groups as well as create, retrieve, and update contact and group associations.

Usage

· molestie consequat

· vel illum dolore eu

· feugiat nulla facilisis at

Global Footer


Page 21 of 25

| WireframesCatalog - WAP - Technical Tab 7/27




API Platform

Global Header

Home > API Catalog > WAP

Products

All API

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Guidelines

Roadmap


WAP Push Messages

Create Push Request

Input Format

Response Parameters

Samples Requests

HTTP Response Codes

The following is a sample response in form-encoded format.

address=tel:+12128675309&address=tel:+12125551212

This API implements a single type of resource – a push request. In order to push content to a mobile device, an application should use this API to create a push request. Each request sends a request into the network, targeted at the specified device address.

Note: Currently, there are no API methods exposed to query the status of a push request, modify or delete it. In the future, these functionalities will be added.

Use this operation in order to create a push request. When the push request is created, it is immediately sent into the network and targeted at the address or addresses in the request. Each push request consists of two parts – a message header and body. The MIME standard is used to differentiate between the two parts of the request.

The first part of the request, the header, determines where it is to be sent, and must be specified in XML, JSON, or “form-encoded” formats.

The second part of the request, the message body, determines the message itself. It is specified in a format determined by the WAP standards.

To create a push request, send an HTTP POST request to the following URL: /1/messages/outbox/wapPush

In common with other AT&T APIs, the response format will be either XML (“text/xml”) or JSON (“application/json”). If XML data is sent as the format of the request, then XML will be returned, and otherwise JSON will be returned.

Create Push Request

The input format for this request is a MIME message. The HTTP “Content-Type” header must be set to “multipart/mixed.” Two parts must follow – the header and the body.

The first part is the header, which must be in one of three formats: “form-encoded” (application/x-www-form-urlencoded), XML (application/xml or text/aml), or JSON (application/json). The next section describes the valid header fields for each.

The second part is the body, which must be in the WAP Push message format. The MIME type must be set to “application/octet-stream”.

Input Format

Response Parameters

Parameter Type Required Value / Rules result String Y The result of the push request.

Sample Requests

The following is a sample of request in JSON format.

{ “addresses” : [ “tel:+12128675309”, “tel:+12125551212” ] }

The following is a sample of request in JSON format.

{ “addresses” : [ “tel:+12128675309”, “tel:+12125551212” ] }

The following is a simpler request in JSON format.

{ “addresses” : “tel:+12128675309” }

The following is a sample of request in XML format.


Page 22 of 25

| WireframesCatalog - Guidelines - 7/20




API Platform

Global Header

Home > API Catalog > Guidelines

Products

All API

Contacts

Device

Location

MMS

Payment

SMS

Speech

WAP Push

Guidelines

Roadmap


Guidelines

Rate Limits

In this environment, request rate are set based on Application or API Key‟s profile. By default an application is associated with Sandbox profile. Application Developer can request an upgrade their application to a Production Bronze or Production Silver profile.

Note 1: Promotion from sandbox to the production environment will cause, a new API Key and Secret Key to be generated. As a result you must make changes to your application to support these changes.

Note 2: Application Shortcode values do not change as an application is promoted from sandbox to production.

Note 3: Changes between various Packages within the production environment will not result in the need for application changes.

Note 4: The sandbox is constrained to 2 TPS and 250 transactions per day per application per API (i.e. Network Service).

Note 5: Once promoted to production you can no longer edit the application configuration data.

Costs

Consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum.

Rate Limits

Costs

erat volutpat

nonummy nibh

Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat.

Back to top

erat volutpat

nonummy nibh

Page Title

Standards

REST

Cross Domain API callAT&T API provides three different mechanisms for Cross Domain API.

Errors response

This is common structure for all the APIs.

OAuth

OAuth2.0 is an emerging standard with added significant security and functionality over the basic authentication. It is much simpler to use and more robust than OAuth version 1. This release of AT&T APIs support OAUTH 2.0 Draft 10 Web Server Profile.

Refer http://tools.ietf.org/html/draft-ietf-oauth-v2-10 for details.

This was copy assigned to

the deleted „Standards‟

page. Needs to be

assigned to Catalog page.

Page 23 of 25


Apigee Home page links

API Platform



Sue Ann Harkey

Home Discuss link

Home Launch link

Home Explore link

Home Learn More link

HTML5

Home View Your Account

link – Dev Center site

My PageHome API link Request TAB

empty messaging

Home – Documentation HTML5

Home – Help Dev Center

Home – SDKs - Sencha

Home API link Response TAB

empty messaging

Home page text blurb links

APIGEE Home

Page 24 of 25


Apigee My Page Links

API Platform



Sue Ann Harkey

My Page – All Apps - trends

My Page – Production

App detail

My Page - Modify

Shortcode App in Sandbox

My Page – App Request

Production Access

My Page – App promoted to

Production Confirm get

Production KEY

My Page – View Production

App detail

My Page – Edit

Production App

My Page – Set up new App

My Page – Set up new App

Confirm get Sandbox KEY

APIGEE Home

Sandbox Apps

Request for Production Access

My Page – All Apps - trends

My Page – App now in Prod.

Suggested future changes to

„Set up a new App‟ page:

- Revise Provision App APIs

functionality to a scalable solution

- Options are under consideration

and include adding left hand

column to display API list with „add‟

functionality

My Page: Addition

of new Reporting

data and

functionality App detail:

Addition of new

Reporting data

and functionality

Edit Production

App: Screen has

limited funcionality

When an App went to

Production there are

now 2 versions in „My

Page‟ one Sandbox,

One Production

Home: Consider

removing, can

redirect to „My

Page‟

Page 25 of 25


Apigee API page links

API Platform



Sue Ann Harkey

Home API link Request TAB

empty messaging


empty messaging


populated


ShareAPIGEE Home

API Consule

APIGEE home

Documentation page examples

Documentation page Documentation page 2

Documentation page Method dropdown

Documents

API Platform IA v8.0sueannharkey.com/wordpress/wp-content/themes/... · create or join an OP to give access to the new API Platform or „Free Trail‟.-A T& erms o fU: M ay hv n