|
|
| (111 intermediate revisions by 7 users not shown) |
| Line 1: |
Line 1: |
| == GOCDB Programmatic Interface ==
| | {{Template:Op menubar}} |
| === Important information about using the GOCDBPI ===
| | {{Template:GOCDB_menubar}} |
| ==== Releases, changes and announcements ====
| | {{TOC_top}} |
| | | [[Category:GOCDB]] |
| All client tool using GOCDB should register someone to the GOCDB discussion mailing list: gocdb-discuss_at_mailtalk.ac.uk. Releases, new features, changes in methods and general announcements related to this interface are made on this list.
| | {{DeprecatedAndMovedTo|new_location=https://gocdb.github.io/api/}} |
| | |
| If your application is using the GOCDB Programmatic interface please request to join this mailing list by sending us a mail to [mailto:gocdb-admins@mailtalk.ac.uk gocdb-admins@mailtalk.ac.uk].
| |
| | |
| <!-- OBSOLETE ==== Recent changes ====
| |
| Some changes have been made to the GOCDB-PI to follow GOCDB-4 model changes. You can browse the change summary page and the list of compatibility tests to know more about this, especially if you were used to the old system. -->
| |
| | |
| === Interface description ===
| |
| ==== Interface type ====
| |
| GOCDB Programmatic Interface is a [http://en.wikipedia.org/wiki/Representational_State_Transfer REST] (Representational State Transfer) based interface over https. The use of https guarantees URLs are properly secured when transiting. Some of the methods are nonetheless public and don't require client side authentication (see [[#Data protection and access]]).
| |
| | |
| ==== Entry point ==== | |
| Enter GOCDB here https://goc.gridops.org/ or directly at https://goc.gridops.org/portal/ to browse the global EGI information or at https://gocdb4.esc.rl.ac.uk/portal to update information.
| |
| | |
| Entry point for every single method is given on method definition pages listed below.
| |
| | |
| ==== Outputs ====
| |
| Output format is '''XML'''. Calling any implemented method will return you a valid DOM document that can be parsed by any tool on client side.
| |
| | |
| ==== Schemas ====
| |
| The associated '''XML schema''' for each method is available by calling the method with "&output=xmlschema", e.g. https://goc.gridops.org/gocdbpi/private/?method=get_site&output=xmlschema
| |
| | |
| | |
| | |
| === Data protection and access ===
| |
| | |
| ==== Protection levels ====
| |
| There are currently 3 protection levels for all methods of the interface
| |
| | |
| * '''Level 1''': public methods (no critical information, no mail, no personal details)
| |
| * '''Level 2''': protected methods (contain mails or personal details)
| |
| * '''Level 3''': private methods (contains security or critical information)
| |
| | |
| Methods at level 1 are available without restrictions. Level 2 requires client to present a valid recognized X509 certificate (reference CA list is the officially agreed EGEE/LCG EUGridPMA list). Level 3 requires client to present a known, registered certificate (certificate DN needs to be stored on GOCDB side for authentication)
| |
| | |
| | |
| ==== How to gain access? ====
| |
| If you need to access protected methods, a valid certificate will be enough. If you need to access private methods, please send a mail to mailto:gocdb-admins@mailtalk.ac.uk, indicating:
| |
The wiki is deprecated and due to be decommissioned by the end of September 2022.