Skip to main content

Survey API आणि MCP

imatic Survey तुमच्या उर्वरित स्टॅकशी जोडते — तुमच्या स्वतःच्या प्रणालींकडे प्रतिसाद पुश करते, फॉर्म काम स्वयंचलित करते, आणि AI एजंटना तुमच्या फॉर्मसह काम करू देते. हे पृष्ठ डेव्हलपर पृष्ठभाग समाविष्ट करते: API की, वेबहुक, REST API, MCP सर्व्हर, आणि ईमेल डिलिव्हरी. ही वैशिष्ट्ये आज थेट आहेत.

इंटिग्रेशन्स आणि डेव्हलपर सेटिंग्ज क्षेत्र डेव्हलपर क्षेत्र हेच आहे जिथे तुम्ही API की, वेबहुक, आणि इंटिग्रेशन्स व्यवस्थापित करता.

API की​

API की तुमच्या स्वतःच्या ॲप्स आणि स्क्रिप्ट Survey REST API विरुद्ध प्रमाणित करतात. त्या /developers/api-keys अंतर्गत तयार आणि व्यवस्थापित करा, जिथे तुम्ही एक की देऊ शकता, तिला एक नाव देऊ शकता, तिची वापर आकडेवारी पाहू शकता, आणि ती कधी उघड झाली तर रद्द करू शकता.

एक की पूर्ण फक्त एकदाच, निर्मितीच्या वेळी दाखवली जाते — तेव्हा ती कॉपी करा आणि सुरक्षित ठिकाणी साठवा. त्यानंतर तुम्हाला सूचीत फक्त तिचा prefix दिसेल, तिच्या नाव, स्कोप, आणि शेवटच्या-वापराच्या वेळेसह.

API https://surveyapi.imatic.ai वर होस्ट केले आहे, आणि की sk_-प्रिफिक्स असलेल्या असतात. तुमची की Bearer token म्हणून पाठवा. एंडपॉईंट हे कस्टम-व्हर्ब POST विनंत्या आहेत — उदाहरणार्थ, तुमचे फॉर्म सूचीबद्ध करण्यासाठी:

curl -X POST https://surveyapi.imatic.ai/forms/list \
  -H "Authorization: Bearer sk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
की गुप्त ठेवा

API की एका पासवर्डसारखी वागवा. ती सोर्स कंट्रोलमध्ये कमिट करू नका, आणि ती लीक झाली असे वाटल्यास ती फिरवा.

वेबहुक​

वेबहुक तुम्ही नियंत्रित करता त्या URL कडे इव्हेंट पुश करतात, जेणेकरून बदलांसाठी पोलिंग करण्याऐवजी काही घडताच तुमच्या प्रणाली प्रतिक्रिया देतात. ती /developers/webhooks अंतर्गत कॉन्फिगर करा.

उपलब्ध इव्हेंट:

  • response.created — एक नवीन प्रतिसाद सबमिट झाल्यावर सुरू होतो.
  • response.flagged (नियोजित — अद्याप उत्सर्जित होत नाही) — एक प्रतिसाद ध्वजांकित झाल्यावर सुरू होईल (उदाहरणार्थ, फसवणूक किंवा स्पॅम तपासणीद्वारे).
  • response.updated (नियोजित — अद्याप उत्सर्जित होत नाही) — एक प्रतिसाद अपडेट किंवा नियंत्रित झाल्यावर सुरू होईल.
  • form.published (नियोजित — अद्याप उत्सर्जित होत नाही) — एक फॉर्म प्रकाशित झाल्यावर सुरू होईल.
  • form.closed (नियोजित — अद्याप उत्सर्जित होत नाही) — एक फॉर्म बंद झाल्यावर सुरू होईल.

प्रत्येक डिलिव्हरी एका HMAC-SHA256 स्वाक्षरीने स्वाक्षरीकृत असते (X-Signature हेडरमध्ये पाठवली, X-Timestamp, X-Event-Id, आणि X-Event-Type सोबत) जेणेकरून तुमचा एंडपॉईंट पडताळू शकेल की विनंती खरोखर imatic Survey कडून आली आणि वाहतुकीत तिच्याशी छेडछाड झाली नाही. अयशस्वी डिलिव्हरी अयशस्वी म्हणून चिन्हांकित करण्याआधी घातीय बॅकऑफसह पुन्हा प्रयत्न केल्या जातात.

REST API​

REST API तुम्हाला फॉर्म आणि प्रतिसाद प्रोग्रामॅटिकली व्यवस्थापित करू देते. एंडपॉईंट हे आवृत्तीकृत पथ-प्रिफिक्सऐवजी कस्टम-व्हर्ब POST विनंत्या वापरतात — उदाहरणार्थ, POST /forms/list (फॉर्म सूचीबद्ध करा), POST /forms/get-for-edit (एका फॉर्मचे स्कीमा वाचा), POST /forms/generate (AI सह एक फॉर्म तयार करा), POST /forms/duplicate, आणि POST /forms/delete. ते https://surveyapi.imatic.ai वर होस्ट केले आहे आणि एका API की ने प्रमाणित केले आहे — एक sk_-प्रिफिक्स असलेला Bearer token.

AI एजंटसाठी MCP सर्व्हर​

MCP सर्व्हर Model Context Protocol द्वारे Survey ला AI एजंटसमोर उघड करतो, जेणेकरून एक सहाय्यक तुमच्या वतीने तुमच्या फॉर्म आणि प्रतिसादांसह काम करू शकेल. तो POST /mcp वर JSON-RPC 2.0 बोलतो आणि तुमच्या portal JWT ने प्रमाणित केला आहे (Bearer token म्हणून पाठवलेला), जो प्रत्येक कॉल तुमच्या संस्थेपुरता स्कोप करतो.

तो 10 साधनांसह येतो:

  • whoami — प्रमाणित संस्था संदर्भ परत करा.
  • list_forms — तुमचे प्रकाशित फॉर्म सूचीबद्ध करा.
  • get_form — एका फॉर्मचे स्कीमा आणि फील्ड वाचा.
  • submit_response — एका फॉर्मला एक प्रतिसाद सबमिट करा.
  • list_responses — प्रतिसाद सूचीबद्ध करा (पृष्ठांकित).
  • get_response — एकच प्रतिसाद वाचा.
  • get_response_stats — एकत्रित प्रतिसाद आकडेवारी वाचा.
  • create_poll — एक एक-प्रश्नी पोल तयार आणि प्रकाशित करा.
  • cast_vote — एका पोलवर एक मत द्या.
  • live_poll_results — थेट पोल मोजणी वाचा.
दोन वेगवेगळी क्रेडेन्शियल

MCP सर्व्हर आणि वेबहुक तुमचे portal JWT (org-स्कोप्ड) वापरतात. REST API तुम्ही /developers/api-keys अंतर्गत तयार करता ती एक API की वापरते. तुम्ही कॉल करत असलेल्या पृष्ठभागासाठी योग्य क्रेडेन्शियल निवडा.

ईमेल डिलिव्हरी​

ईमेल डिलिव्हरी (उदाहरणार्थ, प्रतिसाद सूचना) ईमेल-डिलिव्हरी टॅबवर /settings अंतर्गत कॉन्फिगर केली जाते. तुम्ही सहा प्रदात्यांपैकी कोणताही जोडू शकता:

  • Gmail
  • Resend
  • SendGrid
  • Postmark
  • Amazon SES
  • Custom SMTP

पुढील पावले​