|
|||||||||||||||||||||||||||||
|
general API FAQs
API stands for Application Programming Interface. Orange APIs provide access to Orange network services, personal and communication services as well as multimedia solutions.
Visit the “APIs” section of the Orange Partner website to find out more information about our different suites of APIs and their individual APIs.
You just have to register to become an Orange Partner member which is absolutely free and costs you nothing. Choose the API you want to develop with and you’re ready to get started.
Pricing of the APIs depend on the mode which the API is in. In ‘alpha’ mode, the APIs operate on a free credits basis with limitations. In ‘beta’, the APIs operate on a credits purchase basis.
Pricing also varies from one API suite to another, so for more information please check the “pricing” section of the relevant API.
Some APIs provide worldwide coverage while others are restricted to certain countries only. We are continuously improving our coverage, so please check back for updates.
For more information on coverage, please check the relevant API page.
We introduce new APIs in ‘alpha’ mode. Only when an API is mature enough, will it be moved from ‘alpha’ to ‘beta’ mode and ultimately be released as a final version.
As the APIs are implemented by means of Web Services, the Orange APIs are totally language-independent and can be called from several programming languages.
We provide documentation and application examples in certain languages including PHP, Java and .NET but by no means do no feel restricted to these languages.
We have a developer community within the Orange Partner website where you can post your questions and any problems you may have. Visit the “support” section of “access Orange APIs” area.
Alternatively, you can email us at developers@orange.com where help will be available at hand.
The best way is to send an email to developers@orange.com.
We only provide SDKs for the Advanced APIs. Currently, we do not provide SDKs for the Instant and Personal APIs. However various Orange APIs SDK are available on the web.
Advanced API FAQs
The Advanced APIs is a suite of APIs aimed towards people who wish to use the Orange platforms and services within their applications. These APIs can only be used by companies based in France.
To use the Advanced APIs in your own application, you will need the following:
Check with your systems administrator that the address, port and access point aren’t blocked. In order to check that the access is valid, just enter the service URL in a broswer. You should then get a Http 500 error, an xml message or a certificate validation prompt.
The error displayed is “the underlying connection was closed: Unable to establish a trust relationship for the secure SSL/TLS canal” in .NET OR “Axis Exception à javax.net.SSLHandshakeException: java.security.cert.CertificateException : Couldn’t find trusted certificate” in Java
the certificate currently used by the specific firewall may cause an error. To bypass this, the application must be forced to trust this certificate. Each development language manages connections differently. .NET for example bases itself on default certificates for Windows (in Tools > Internet Option > Content > Certificates). Java uses “keystores” which can be modified with the “keytool” utility.
In Java, for the service to work, please follow the instructions in ‘Prerequisite documentation’ relating to certificate management.
There is an authentication problem. The platform uses the ‘Basic Authorization’ method. Please ensure your programme is parameterized to use this method and that you are using the correct IDs to access the Orange network.
The parameter “Partner_API_Account_ID” needed in the SOAP Header is not defined or incorrectly declared. Make sure you are using the correct login for this service and implement it correctly in the SOAP Header request.
Audio .wav files need to be Mono, 8bits, 8khz, CCIT A-Law, with a size inferior to 2Mb
Currently, the joinConference method email field is not used. This parameter will be used in a future version of the MMC API. You will have to communicate connection details to your participants manually.
The DCE service only returns the first 10 results to a search. Try to narrow the search down by including the model.
Special characters used in attachment filenames will be replaced with ‘_’. Furthermore, if sending a standard attachment and an audio file, they must be named differently. Attachment file size must not exceed 2Mb.
The recipients XML string is incorrect. If you are using the SDK Java, please make sure that you are using the libraries for this SDK. For example, the version 1.2 of Xstream has a bug. You have to use version 1.2.2.
If the recipient is subscribed to SFR, the number displayed will be 10108. But if the recipient is subscribed to Orange or Bouygues Telecom, then the number displayed will also depend on the type of contract. If the contract is of marketing, interpersonal or professional type, then the number displayed will be 36028, 37028 ou 38028 respectively.
It is the simple GSM alphabet which is used:
Any other character will be replaced by '?' or will undergo the following conversion:
Instant API FAQs
The Instant APIs is a suite of APIs aimed towards people or developers who wish to use the Orange network platforms and services within their applications.
It is a virtual object with which the user interacts – a dynamic “shortcut” for a regular reporting requirement e.g. a currency exchange rate that can be updated for different currencies or the temperature of a location that can be updated for different locations.
Anyone! Instant APIs are for hobbyist, developers and business.
To be able to use the Instant APIs, you must become an orangepartner member which is free and costs you absolutely nothing. Then, you can get your key from the API manager.
The Access Key is a string that identifies your account (not your application): the key is personal and ideally must be kept secret.
If the API is in ‘alpha’ mode, you do not need any credits as these APIs are totally free. If the API is in ‘beta’ mode, you can purchase more credits with your credit card in the API manager.
We introduce new APIs in ‘alpha’ mode and when an API is mature enough, they will be moved from ‘alpha’ to ‘beta’ and then full commercial mode.
Currently, the APIs in ‘alpha’ mode are free to use with some volume limitations, for example a daily limit of 10 SMS/day
The APIs in ‘beta’ mode may have some coverage limitations where only certain countries are covered.
This depends on the API maturity level. First an API is released in ‘alpha’ where it is free with daily quotas, and then evolves to ‘beta' mode where credits are needed to use it but it is not limited in terms of use.
Yes, replace http by https when you call the web service methods.
It allows you to control and configure all aspects of the APIs and of your account (Access Key, prepaid account, revenue sharing, usage history …).
This is a key which can be found in the API Manager. It is a parameter needed to use our APIs which allows us to identify you and your usage..
No it’s automatically generated.
Yes, from the API Manager (important if you think someone stole your Access key).
Yes, you can set a "Warning on low credit" amount that will alert you by email when you are under a certain number of credits which you can define. Personal API FAQs
The Personal APIs is a suite of APIs allowing you access the services used by Orange France’s customers’ like favourites, content, etc.
You must accept our terms and conditions when subscribing to APIs. Please read them carefully.
We are working on extending our APIs to mobile phones.
We have developed a Privacy Dashboard, where you can see history of requests, sharing rules, partners, etc. Visit http://privacy.orange.fr for more information.
The Orange authentication service available on partners’web sites allows two authentication protocols:
For further information, go to http://openid.orange.fr .
Currently, only Orange Authentication provides access to other Personal APIs.
|
||||||||||||||||||||||||||||
