vOs⁴OVirtual Observatory Solar System Scaling Service for Outreach

API - वेब सेवा

के बारे में

API (एप्लीकेशन प्रोग्रामिंग इंटरफेस) सीधे अपने स्वयं के सॉफ़्टवेयर से VOS⁴O से पूछताछ करने की अनुमति देता है। आप इसका उपयोग सौर मंडल को स्केल करने के लिए अपना स्वयं का वेब पेज बनाने के लिए कर सकते हैं, या प्रश्नों को स्क्रिप्ट कर सकते हैं और उत्पन्न तालिका और छवियों को पुनर्प्राप्त कर सकते हैं। सेवा पूछने के लिए दो विधियां उपलब्ध हैं:

• HTTP request: बस गैर-इंटरैक्टिव इंटरनेट डाउनलोड सॉफ़्टवेयर जैसे कि wget, curl या जावास्क्रिप्ट ऑब्जेक्ट XMLHttpRequest के माध्यम से सेवा से पूछताछ करें।
• Web Service : SOAP+WSDL+HTTP प्रोटोकॉल के आधार पर अपनी वेब सेवा (WS) के माध्यम से सर्विसे से पूछें।

API का उपयोग किसी भी गैर-लाभकारी उपयोग (व्यक्तिगत या शैक्षणिक) के लिए नि: शुल्क (स्वतंत्रता में) है और मुफ़्त है। यदि आप VOS⁴O सेवा का उपयोग करके कोई एप्लिकेशन विकसित करते हैं तो अपडेट कॆ बारॆ मॆ सूचनाएं प्राप्त करने के लिए हमसे संपर्क करने की अत्यधिक अनुशंसा करते हैं।

किसी भी गलती की रिपोर्ट करने या नई कार्यक्षमताओं का अनुरोध करने के लिए कृपया हमारे बग ट्रैकर का उपयोग करें।

पैमाने की परिभाषा

पैमाने को परिभाषित करने के तीन तरीके हैं :

x:y

हर एक to define a multiplying coefficient X/Y to apply to every single length. उदाहरण के लिए, स्केल 1: 1000000 (दस लाखवां) एक ग्रह से सभी ग्रह दूरी और व्यास विभाजित करेगा।

a(planet):x

x के रूप में ग्रह की दूरी जैसे पैमाने को निर्धारित करने के लिए। उदाहरण के लिए, यदि पैरामीटर unit=m (meter), तो स्केल a(neptune):7.22 सौर मंडल का एक दृश्य बनाएगा जिसमें दूरी सूर्य – नेप्च्यून 7.22 मीटर है।

d(planet):x

x के रूप में ग्रह के व्यास जैसे पैमाने को सेट करने के लिए। उदाहरण के लिए, यदि पैरामीटर इकाई=m (मीटर), तो स्केल d(earth):1 एक सौर मंडल तैयार करेगा जिसमें पृथ्वी का व्यास 1 मीटर के बराबर होगा।

आउटपुट तालिका और छवियों का विवरण

VOS⁴O द्वारा उत्पन्न आउटपुट तालिका सूर्य और ग्रहों के व्यास, और ग्रहों और सूर्य के बीच की दूरी को सूचीबद्ध पैमाने पर सेट करता है। ग्रहों की कक्षीय विकेन्द्रता, और अनुरोधित युग में उनके औसत हेलीओसेन्ट्रिक रेखांश (डिग्री में), की भी सूचना दी गई है।

VOS⁴O द्वारा उत्पन्न पहली छवि परिभाषित मानकों के अनुसार, सौर मंडल को स्केल करने के लिए सेट करती है। ग्रहों को उनके सही संबन्द्धित दूरी पर लॉगरिदमिक पैमाने वाली अक्ष मे लिखा जाता है। हर एक के बगल में, इसका व्यास और सूर्य से दूरी (स्केल सॆ निर्धारित) की सूचना दी जाती है।

दूसरी छवि ऊपर से देखा गया सौर मंडल का प्रतिनिधित्व करती है। हर एक ग्रह अनुरोधित युग में गणना की गई अपने औसत हेलीओसेन्ट्रिक रेखांश पर अपनी कक्षा पर स्थित है। The reference for the longitudes is the mean vernal point (or mean equinox), represented by the γ symbol.

HTTP अनुरोध

गैर-इंटरैक्टिव इंटरनेट सॉफ़्टवेयर जैसे कि (wget, curl), या किसी इंटरनेट ब्राउज़र के साथ, सेवा को इसके नीचॆ दिए गए HTTP access point से बुला सकॆ

https://ssp.imcce.fr/webservices/vos4o/scale.php?[parameters]

जिसमें [पैरामीटर] & प्रतीक द्वारा अलग पैरामीटर (तालिका 1 में परिभाषित) की एक सूची है। यदि कोई पैरामीटर सेट नहीं है, तो सेवा तालिका 1 में सूचीबद्ध डिफ़ॉल्ट मानों के साथ सौर मंडल को सेट करती है।

^* यदि MIME प्रकार VOTABLE है, तो autoscale पैरामीटर इसके मान के बावजूद 0 पर सेट है।

HTTP अनुरोध का नतीजा एक तालिका और दो छवियों में होता है, जो HTML, VOTable/XML या निर्दिष्ट MIME प्रकार (-mime पैरामीटर) के अनुसार सरल टेक्स्ट में बनाए जाते हैं।

अनुरोधों के उदाहरण :

• scale 1:1000000 स्केल(दस लाखवां) करने के लिए सौर मंडल ।
• The solar system such as the the distance Sun - Neptune is 7.22 meters.
• सौर मंडल जैसे पृथ्वी के व्यास मीटर के बराबर होती है।

वेब सेवा

VOS⁴O सेवा को SOAP+WSDL+HTTP प्रोटोकॉल के आधार पर वेब सेवा के माध्यम से पूछताछ की जा सकती है जो आपके अपने आवेदन और सेवा के बीच सीधी बातचीत के लिए अनुमति देता है।

वेब सेवा URI :

https://ssp.imcce.fr/webservices/vos4o/vos4o.php

नाम स्थान :

https://ssp.imcce.fr/webservices/vos4o

WSDL:

https://ssp.imcce.fr/webservices/vos4o/vos4o.php?wsdl

SOAP header:

SOAP header का नाम: : clientID

SOAP header : array('from' => 'NomProjet', 'hostip'=>'')

तरीका :

scale (inputArray)

इनपुट पैरामीटर

स्केल विधियों के इनपुट पैरामीटर को तालिका में समूहीकृत किया जाता है और तालिका 2 में वर्णित चर को परिभाषित करना होगा।

^* यदि MIME प्रकार VOTABLE है तो ऑटोस्केल पैरामीटर को इसके मूल्य के बावजूद झूठी मजबूर होना पड़ता है।

आउटपुट पैरामीटर

'स्केल' विधि के परिणाम निम्न गुणों वाला एक ऑब्जेक्ट है :

'स्थिति'

उत्तर कोड की स्थिति, HTTP कोड के आधार पर: 200 = ठीक है, 400 = खराब अनुरोध, 404 = नहीं मिला, 500 = आंतरिक त्रुटि।

'टिकट'

उत्तर का टाइमस्टैम्प।

'परिणाम'

एक स्ट्रिंग जिसमें परिणाम तालिका और सौर मंडल की छवियां स्केल होती हैं।

MIME प्रकार

चयनित MIME प्रकार के अनुसार, उत्तर निम्न प्रारूप में प्रदान किया गया है :

votable

IVOA के VOTable मानक के बाद डेटा XML दस्तावेज़ में लिखा जाता है

html

डेटा एक HTML5 दस्तावेज़ में लिखा गया है

टेक्स्ट

डेटा एक सादे टेक्स्ट दस्तावेज़ में लिखा गया है।

कैसे ?

स्केलिंग सेवा का उपयोग करने के दो तरीके हैं : क्लायन्ट को VOS⁴O सर्वर से अनुरोध भेजने के लिए और उत्तर प्राप्त करने और उसका शोषण करने के लिए, या वेब ब्राउज़र या डेटा ट्रांसफर सॉफ़्टवेयर जैसे curl या wget के माध्यम से। ऐसे मामले में, आपको टर्मिनल में निकालना चाहिए :

$> curl "<URL>"

or

$> wget "<URL>"

जिसमें HTTP अनुरोध खंड में <URL> वर्णित है।

VOS⁴O सेवा का अनुरोध करने वाले सॉफ़्टवेयर को लिखने के लिए, एक भाषा चुनें जो संचार प्रोटोकॉल SOAP लागू करती है। हमने यहां PHP में लिखे गए एक उदाहरण प्रदान किए हैं :

// Client's ID: provide the name of your project or organisation
                $from = 'MyName';
// Input parameters
$param = array('scale' => 'd(Terre)=1.0',
               'autoscale' => true,
               'scalefactor' => 1.0,
               'unit' => 'm',
               'axis' => 'log',
               'lang' => 'hi-hi',
               'mime' => 'html',
               'epoch' => 'now');

// Enables or disables the WSDL caching feature
ini_set('soap.wsdl_cache_enabled', 1);
// VOS4O name space
$namespace = 'https://ssp.imcce.fr/webservices/vos4o';
// VOS4O WSDL
$uriwsdl = $namespace.'/vos4o.wsdl';

try {
  // Instantiate the client
  $client = new SoapClient($uriwsdl, array('exceptions'=>1));
  // SOAP header
  $header = array('from'=>$from, 'hostip'=>'');
  $client->__setSoapHeaders(array(
     new SOAPHeader($namespace, 'clientID', $header)
  ));  
  // Call the resolver method
  $response = $client->__soapCall('scale',array($param));
  // Display the results
  if ($param['mime'] == 'text') {
    header("HTTP/1.0 ".$response->status);
    header("Content-Type: text/plain");
    $res = split(';', $response->result);
    $nbr = count($res);
    $newkey = array_keys($res);
    for ($i=0; $i<$nbr; $i++) { echo $res[$newkey[$i]].PHP_EOL; };
  } else if ($param['mime'] == 'html') {
    header("HTTP/1.0 ".$response->status);
    header("Content-Type: text/html");
    echo $response->result;
  } else {
    header("HTTP/1.0 ".$response->status);
    header("Content-Type: text/xml");
    echo $response->result.PHP_EOL;
  }
} catch (SoapFault $fault) {
  trigger_error("SOAP Fault: {$fault->getTraceAsString()} 
      (faultcode: {$fault->faultcode}, 
       faultstring: {$fault->faultstring})", E_USER_ERROR);
}