The world of Oracle API
Posted By Sanjit Anand On February 12, 2008 @ 8:05 am In API Integration,EBS Suite | 14 Comments
There are 3 types of APIs exist in EBS.
Private APIs : Private API's are one which Oracle normally using internal, development purpose only. Details are not provided to anyone outside of the immediate development environment, nor are they intended for use by anyone outside of the e-Business Suite development environment.
Public APIs : These are designed for customers and Oracle consultants to integrate non-Oracle systems into Oracle e-Business Suite or to extend the functionality of the base products. Oracle does not support public APIs unless they are published in a reference manual.
Public, published APIs : These are one which Oracle guaranteed to remain valid from release to release, and patches will not alter the API behaviour. Public, published APIs are supported by Oracle to the same extent as released software.
Is there any way find out whether a standard API is PUBLIC or not in Oracle Application?
Yes, there is way, what you have do ,once you are able to find the information for API from irep [1], the next you have to find the file name and then you need to pull all information from specification header to know which one is public.
Take a simple case, you need to find API FND_USER_PKG which is defined in file AFSCUSRB.pls
logon to Unix box, and release this sort of command
grep -i public $FND_TOP/patch/115/sql/AFSCUSRB.pls
Based on the above result one can determine whether API is PUBLIC or not.
Simple example for checking AR Public APIs for finding the status
grep -i public $AR_TOP/patch/115/sql/ARXPRELB.pls
grep -i public $AR_TOP/patch/115/sql/ARXPRELS.pls
grep -i public $AR_TOP/patch/115/sql/ARXPRECS.pls
grep -i public $AR_TOP/patch/115/sql/ARXPRECB.pls
Important to Note:
For non-published APIs, Oracle expressly does not provide any guarantees regarding consistency of naming, usage, or behaviour of any API (public or private) between releases.
It Might be possible that a patch could alter any characteristic of any non-published e-Business Suite API.
Where are APIs located ?
For Oracle release 10.7, the APIs are located in the operating system directories such as:
$APPL_TOP/patchsc/107/sql
For Oracle release 11 and release 11i, the APIs are located in the operating system directories:
$APPL_TOP/patch/xxx/sql
where xxx represents the release 110 or 115.
Is there any tracking mechanism for API versions in different Applications releases?
As confirmed by some time back by Oracle support team , there is no such database object in Oracle Applications that keep such kind of information.
All APIs are owned and managed by different product groups within Oracle.
Normally each release comes with either product update notes, or and "About" note. You would need to review these documents for each E-Business Product.
The most comprehensive are the family pack "About" notes, as they in turn reference each individual product "About" note, which lists things like "Changes".
14 Comments (Open | Close)
Article printed from OracleApps Epicenter: http://www.oracleappshub.com
URL to article: http://www.oracleappshub.com/ebs-suite/the-world-of-oracle-api/
URLs in this post:
[1] irep: http://irep.oracle.com
Click here to print.
14 Comments To "The world of Oracle API"
#1 Comment By Nigel Thomas On February 12, 2008 @ 6:55 am
Sanjit – there’s a little error in the first bullet:
“Private APIs : Public API’s are…”
Substitute Private instead of Public.
Good work!
Regards Nigel
#2 Comment By sanjit On February 12, 2008 @ 8:08 am
Thanks Nigel for nice word.
#3 Pingback By API’s or Open Interface On February 12, 2008 @ 9:38 pm
[...] or Open InterfaceThe world of Oracle APIPO: Tips and useful QuerySubscribeHappy Lunar new yearHighlights:Release 12 Oracle EBS FinancialsR12 [...]
#4 Comment By Ramesh On February 25, 2008 @ 7:00 am
What is the difference b/w Oracle API and Oracle standard Package?
Regards Ramesh
#5 Pingback By Approved Supplier Lists (ASL) On July 20, 2008 @ 6:58 pm
[...] Usage Note :**Don’t use private API’s , unless Oracle is documented, these are mostly used by Oracle development purpose, unless untill [...]
#6 Pingback By AR Invoice API (Application Program Interface ) On September 2, 2008 @ 2:35 am
[...] The world of Oracle API [...]
#7 Pingback By AR Deposit : Details, setup, Flow, Accounting and API On September 3, 2008 @ 8:01 am
[...] The world of Oracle API [...]
#8 Pingback By AR Adjustments : Details,setup, Flow, Accounting and API (Part -II) On September 5, 2008 @ 8:34 am
[...] The world of Oracle API [...]
#9 Pingback By AR Adjustments : API – Sample code On September 5, 2008 @ 5:43 pm
[...] The world of Oracle API [...]
#10 Pingback By A Newbie’s Guide to E-Business Suite Integration (by Custom Code using API’S!”) On September 9, 2008 @ 12:34 am
[...] First thing you have to do is, you need to initialize Applications Information such as user_id,responsiblity_id and application_id if you are in R11i. For R12,there is slightly change in APPS initialization. [...]
#11 Pingback By Bespoke Application & Utilizing HR/Payroll APIs | OracleApps Epicenter On December 16, 2008 @ 8:57 pm
[...] The world of Oracle API [...]
#12 Comment By Ravi On January 15, 2009 @ 11:42 am
Hi all,
Is there any guidelines for standard APIs ?
The disadvantage in using API i feel is that it is very hard to debug if some thing goes wrong.
Regards,
Ravi.
#13 Pingback By TCA : Party Purge API | OracleApps Epicenter On February 4, 2011 @ 9:54 pm
[...] This API is not published by Oraclc for public use. You can check thIS post before using Oracle API's. [...]
#14 Comment By Srikanth On March 20, 2012 @ 10:46 am
Can you please give me the list of Public APIs for iExpense module.