# சர்வே API & MCP


# சர்வே API & MCP

imatic Survey உங்கள் ஸ்டாக்கின் மற்ற பகுதிகளுடன் இணைகிறது — பதில்களை உங்கள் சொந்த அமைப்புகளுக்குத் தள்ளுவது, படிவ வேலையை தானியக்கமாக்குவது, AI முகவர்களை உங்கள் படிவங்களுடன் வேலை செய்ய அனுமதிப்பது. இந்தப் பக்கம் டெவலப்பர் மேற்பரப்பை உள்ளடக்குகிறது: API keys, webhooks, REST API, MCP சர்வர், மற்றும் மின்னஞ்சல் வழங்கல். இந்த அம்சங்கள் இன்று நேரடியாகச் செயல்படுகின்றன.

![ஒருங்கிணைப்புகள் மற்றும் டெவலப்பர் அமைப்புகள் பகுதி](/img/screenshots/survey/integrations.png)
*டெவலப்பர் பகுதி நீங்கள் API keys, webhooks, மற்றும் ஒருங்கிணைப்புகளை நிர்வகிக்கும் இடம்.*

## API keys

API keys உங்கள் சொந்த ஆப்களையும் ஸ்கிரிப்ட்களையும் சர்வே **REST API**-க்கு எதிராக அங்கீகரிக்கின்றன. அவற்றை **/developers/api-keys**-ன் கீழ் உருவாக்கி நிர்வகியுங்கள், அங்கு நீங்கள் ஒரு கீயை வழங்கலாம், அதற்கு ஒரு பெயரிடலாம், அதன் பயன்பாட்டுப் புள்ளிவிவரங்களைப் பார்க்கலாம், எப்போதேனும் வெளிப்பட்டால் அதை ரத்து செய்யலாம்.

ஒரு கீ முழுமையாக ஒரே ஒரு முறை மட்டுமே காட்டப்படுகிறது, உருவாக்கும்போது — அப்போதே அதை நகலெடுத்து பாதுகாப்பான இடத்தில் சேமித்து வைக்கவும். அதற்குப் பிறகு நீங்கள் பட்டியலில் அதன் முன்னொட்டை மட்டுமே, அதன் பெயர், ஸ்கோப்கள், கடைசியாகப் பயன்படுத்திய நேரத்துடன் காண்பீர்கள்.

API ஆனது `https://surveyapi.imatic.ai`-இல் ஹோஸ்ட் செய்யப்பட்டுள்ளது, கீகள் `sk_`-முன்னொட்டுடன் இருக்கும். உங்கள் கீயை ஒரு Bearer டோக்கனாக அனுப்புங்கள். எண்ட்பாயிண்ட்கள் custom-verb POST கோரிக்கைகள் — எடுத்துக்காட்டாக, உங்கள் படிவங்களைப் பட்டியலிட:

```bash
curl -X POST https://surveyapi.imatic.ai/forms/list \
  -H "Authorization: Bearer sk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

:::tip[கீகளை ரகசியமாக வைத்திருங்கள்]

ஒரு API key-ஐ ஒரு கடவுச்சொல்லைப் போல நடத்துங்கள். அதை source control-க்கு கமிட் செய்யாதீர்கள், கசிந்திருக்கலாம் என்று சந்தேகித்தால் அதைச் சுழற்றுங்கள்.

:::

## Webhooks

Webhooks நீங்கள் கட்டுப்படுத்தும் ஒரு 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** படிவங்களையும் பதில்களையும் நிரல்வழியாக நிர்வகிக்க உங்களை அனுமதிக்கிறது. எண்ட்பாயிண்ட்கள் ஒரு பதிப்பிடப்பட்ட பாதை முன்னொட்டுக்குப் பதிலாக custom-verb POST கோரிக்கைகளைப் பயன்படுத்துகின்றன — எடுத்துக்காட்டாக, `POST /forms/list` (படிவங்களைப் பட்டியலிட), `POST /forms/get-for-edit` (ஒரு படிவத்தின் ஸ்கீமாவைப் படிக்க), `POST /forms/generate` (AI மூலம் ஒரு படிவத்தை உருவாக்க), `POST /forms/duplicate`, மற்றும் `POST /forms/delete`. இது `https://surveyapi.imatic.ai`-இல் ஹோஸ்ட் செய்யப்பட்டு, ஒரு [API key](#api-keys) மூலம் அங்கீகரிக்கப்படுகிறது — ஒரு `sk_`-முன்னொட்டு Bearer டோக்கன்.

## AI முகவர்களுக்கான MCP சர்வர்

**MCP சர்வர்** Model Context Protocol மூலம் சர்வேயை AI முகவர்களுக்கு வெளிப்படுத்துகிறது, இதனால் ஒரு உதவியாளர் உங்கள் சார்பாக உங்கள் படிவங்களுடனும் பதில்களுடனும் வேலை செய்ய முடியும். இது `POST /mcp` மீது **JSON-RPC 2.0**-ஐப் பேசுகிறது, உங்கள் போர்டல் **JWT** மூலம் (Bearer டோக்கனாக அனுப்பப்படுகிறது) அங்கீகரிக்கப்படுகிறது, இது ஒவ்வொரு அழைப்பையும் உங்கள் நிறுவனத்திற்கு ஸ்கோப் செய்கிறது.

இது **10 கருவிகளுடன்** வருகிறது:

- **`whoami`** — அங்கீகரிக்கப்பட்ட நிறுவன சூழலைத் திருப்பித் தருகிறது.
- **`list_forms`** — உங்கள் வெளியிடப்பட்ட படிவங்களைப் பட்டியலிடுகிறது.
- **`get_form`** — ஒரு படிவத்தின் ஸ்கீமாவையும் புலங்களையும் படிக்கிறது.
- **`submit_response`** — ஒரு படிவத்திற்கு ஒரு பதிலைச் சமர்ப்பிக்கிறது.
- **`list_responses`** — பதில்களைப் பட்டியலிடுகிறது (பக்கமாக்கப்பட்டது).
- **`get_response`** — ஒரு தனிப் பதிலைப் படிக்கிறது.
- **`get_response_stats`** — திரட்டப்பட்ட பதில் புள்ளிவிவரங்களைப் படிக்கிறது.
- **`create_poll`** — ஒரு ஒற்றை-கேள்வி வாக்கெடுப்பை உருவாக்கி வெளியிடுகிறது.
- **`cast_vote`** — ஒரு வாக்கெடுப்பில் ஒரு வாக்கைப் பதிவு செய்கிறது.
- **`live_poll_results`** — நேரடி வாக்கெடுப்பு எண்ணிக்கைகளைப் படிக்கிறது.

:::info[இரண்டு வெவ்வேறு சான்றுகள்]

**MCP சர்வரும் webhooks-உம்** உங்கள் போர்டல் **JWT**-ஐப் (நிறுவன-ஸ்கோப்) பயன்படுத்துகின்றன. **REST API** நீங்கள் /developers/api-keys-ன் கீழ் உருவாக்கும் ஒரு **API key**-ஐப் பயன்படுத்துகிறது. நீங்கள் அழைக்கும் மேற்பரப்புக்கு சரியான சான்றைத் தேர்ந்தெடுங்கள்.

:::

## மின்னஞ்சல் வழங்கல்

மின்னஞ்சல் வழங்கல் (எடுத்துக்காட்டாக, பதில் அறிவிப்புகள்) **/settings**-ன் கீழ் மின்னஞ்சல்-வழங்கல் தாவலில் கட்டமைக்கப்படுகிறது. நீங்கள் **ஆறு வழங்குநர்களில்** எதையும் இணைக்கலாம்:

- **Gmail**
- **Resend**
- **SendGrid**
- **Postmark**
- **Amazon SES**
- **Custom SMTP**

## அடுத்த படிகள்

- [ஒரு படிவத்தை வெளியிட்டுப் பகிருங்கள்](./publishing-sharing)
- [பதில்களைப் பார்க்கவும்](./responses)
- [பகுப்பாய்வைத் திறங்கள்](./analytics)
- [AI மூலம் ஒரு படிவத்தை உருவாக்குங்கள்](./ai-generation)
