Device Capability Enabler API

home

forums

become a member

Français

our programme

mobile apps & solutions

other innovation

APIs

news & events

instant APIs

personal APIs

printer-friendly format

Device Capability Enabler API provides your application with information on mobile devices' capabilities such as screen size, user-agent, MMS support, supported codec for music and video downloads.

Device Capability Enabler API

overview
technical features
pricing
development

The Device Capability Enabler web service provides your application with information on mobile devices' capabilities such as screen size, user-agent, MMS support, supported codec for music and video downloads.

A device capability is a hardware or a software feature, and its knowledge enables you to adapt your service to each user.

The enabler can request device capability using one of the three criteria used to identify a device:
search by brand / model name
search by TAC code (IMEI prefix)
search by User-agent

A very significant and growing number of different devices are being used by Orange customers, each one of them possessing veriety of features. In order to propose and deliver services best suited to the end-users' device, relevant information about the capabilities of the device is required.

benefits

The enabler lets you take advantage of Orange's knowledge of mobile device used by its customers, enabling you to focus on your services.

The device repository is updated every time Orange's device knowledge improves (with device amendments or new devices).

supported protocols

HTTPS
web services, SOAP protocol

functions

DCE provides three search services that return device capabilities based on search criteria provided:

search by brand/model name getDeviceCapabilitiesByName
search by TAC code (IMEI prefix) getDeviceCapabilitiesByTacCode
search by user-agent getDeviceCapabilitiesByUserAgent

characteristics

search by brand/model name
   - input brand and/or model (brand and model cannot be both empty)
   - return a list of devices capabilities corresponding to the brand/model name
   - maximum number of answers: the capabilities of 10 devices

search by TAC code
   - input a TAC code
   - return a list of devices capabilities corresponding to the TAC code
   - maximum number of answers : the capabilities of 10 devices

search by user-agent
   - input a user agent string
   - return a list of devices capabilities corresponding to the user agent
   - maximum number of answers: the capabilities of 10 devices.

limitations

Maximum number of answers: the capabilities of 10 devices.

Some capabilities may differ from the ones we know about (eg: an advanced user may have updated his software).

architecture diagram

errors

functional
- NoDeviceFound (code 1) No device corresponds to your search criteria.
- UnknownUser (code 2) The user is unknown or bad password

technical
- databaseException (code -1) Database Error (HibernateException caught)
- UnknownException (code -99) Unknown Error (Throwable caught)

This API is free to use

development material

Development kits (libraries and documentations including code samples, covered by Apache 2 licence):

Java 1.5

zip icon Java development kit (v 1.1.3)

includes documentation, reference manual and source files

Java SDK manual (v 1.1.3)

.NET 3.5

zip icon C# development kit (v 1.1.3)

includes documentation, reference manual and source files

C# SDK manual (v 1.1.3)

You can also download the Orange API SDK on CodePlex. Especially, this global .Net SDK contains dedicated samples for this API.

PHP version 5

zip icon PHP development kit (v 1.1.3)

includes documentation, reference manual and source files

PHP SDK manual (v 1.1.3)

Direct integration of SOAP WSDL:

WSDL integration

zip icon WSDL and integration document (v 1.1.3)

includes documentation, reference manual and call examples

developer manual (v 1.1.3)

Server certificate:

server certificate

zip icon SSL server certificate

required for SSL authentication.

Using the API is simple. Just follow the steps below:

test the API

Prerequisite: becoming Premium member

To test an API, you need to registrer in Orange Partner web site (member), and to become

a Premium member.

If you're not already an Orange Partner member, become one now, and make sure

you tick the "Yes, I am interested in using Orange APIs" box on the membership

form.

If you're already an Orange Partner member, sign in, and verify your account:
tick the "Yes I am interested in using Business APIs" box.

To become Premium member, please complete the registration form (don't forget to tick

« Please tick the box if you're a business based in France wishing to access

trial and live APIs ») and enter your SIRET number.

If you are already Premium member, sign in, and verify your account: tick « Please tick

the box if you're a business based in France wishing to access trial and live

APIs » and enter your SIRET number.

In both cases, you will receive an acknowledgement by email, and, in a few days, a

confirmation of your Premium status.

Once Premium member, click on the "test" button above, to obtain the credentials needed to integrate the test API.

Depending on your integration mode and development language, download above:

One development kit, for java, .Net or PHP, and the documentation.

The WSDL description and the direct integration guide.

Follow the instructions of the documentation above to integrate the API.

buy the API

You have tested the API... Happy with it?

Prerequisite: becoming Contracted member

Your account manager from Orange Business Services will present you advantages

and terms of the Orange partnership, and the associated contract.

Once contracted partner, click on the "buy" button above, to obtain the credentials needed to integrate the test API.

Then, manage yours APIs, with the *** API manager *** left hand side menu.

(back to top)

related tags

advanced APIs (11)

bookmark and share

what is social bookmarking?

del.icio.us

Digg

facebook

Google

StumbleUpon

technorati

please note...

This API is only for use by
companies based or having a
subsidiary in France

Please read the user guide

(in French)

something not clear?

try the following...

read the user guide

Please make sure you have a look at the user guide we've created. It takes you through the different stages of developing with this API.

download the user guide (in French)

read the FAQs

Please make sure you have a look at the FAQs.

FAQs

use the discussion forum

We've set-up a discussion forum for all the APIs. Many of you are already using it.

Ask your question by creating a new topic, or have a conversation with other members using the APIs.

access the forum

still stuck?

email us

Get in touch with us at developers@orange.com

download the Unified SDK

The unified SDK is the aggregation of all SDK developed for both Advanced and most Instant APIs.

This means that you can use the single Unified SDK to develop with APIs from both the families.

download now