# సర్వే API & MCP


# సర్వే API & MCP

imatic సర్వే మీ మిగతా స్టాక్‌తో కనెక్ట్ అవుతుంది — ప్రతిస్పందనలను మీ స్వంత సిస్టమ్‌లకు పంపడం, ఫారమ్ పనిని ఆటోమేట్ చేయడం, మరియు AI ఏజెంట్‌లు మీ ఫారమ్‌లతో పనిచేయడానికి అనుమతించడం. ఈ పేజీ డెవలపర్ ఉపరితలాన్ని వివరిస్తుంది: API కీలు, webhooks, REST API, MCP సర్వర్, మరియు ఇమెయిల్ డెలివరీ. ఈ ఫీచర్‌లు ఈ రోజు లైవ్‌లో ఉన్నాయి.

![ఇంటిగ్రేషన్‌లు మరియు డెవలపర్ సెట్టింగ్‌ల ప్రాంతం](/img/screenshots/survey/integrations.png)
*డెవలపర్ ప్రాంతం అనేది API కీలు, webhooks, మరియు ఇంటిగ్రేషన్‌లను మీరు నిర్వహించే చోటు.*

## API కీలు

API కీలు సర్వే **REST API**కి వ్యతిరేకంగా మీ స్వంత యాప్‌లు మరియు స్క్రిప్ట్‌లను ప్రామాణీకరిస్తాయి. మీరు వాటిని **/developers/api-keys** కింద సృష్టించి నిర్వహిస్తారు, అక్కడ మీరు ఒక కీని జారీ చేయవచ్చు, దానికి ఒక పేరు ఇవ్వవచ్చు, దాని వినియోగ గణాంకాలను చూడవచ్చు, మరియు అది ఎప్పుడైనా బహిర్గతమైతే దాన్ని రద్దు చేయవచ్చు.

ఒక కీ పూర్తిగా ఒకేసారి మాత్రమే చూపించబడుతుంది, సృష్టి సమయంలో — దాన్ని అప్పుడే కాపీ చేసి సురక్షితమైన చోట నిల్వ చేయండి. ఆ తర్వాత మీరు జాబితాలో దాని ప్రిఫిక్స్‌ను మాత్రమే చూస్తారు, దాని పేరు, స్కోప్‌లు, మరియు చివరిగా ఉపయోగించిన సమయంతో పాటు.

API `https://surveyapi.imatic.ai` వద్ద హోస్ట్ చేయబడింది, మరియు కీలు `sk_`-ప్రిఫిక్స్‌తో ఉంటాయి. మీ కీని ఒక Bearer టోకెన్‌గా పంపండి. ఎండ్‌పాయింట్‌లు కస్టమ్-క్రియ 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 కీని పాస్‌వర్డ్‌లా పరిగణించండి. దాన్ని సోర్స్ కంట్రోల్‌కు కమిట్ చేయవద్దు, మరియు అది లీక్ అయిందని మీరు అనుమానిస్తే దాన్ని తిప్పండి.

:::

## 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 సర్వే నుండి వచ్చిందని మరియు ట్రాన్సిట్‌లో తారుమారు చేయబడలేదని ధృవీకరించగలదు. విఫలమైన డెలివరీలు విఫలమైనవిగా గుర్తించబడకముందు ఎక్స్‌పొనెన్షియల్ బ్యాకాఫ్‌తో **మళ్లీ ప్రయత్నించబడతాయి**.

## 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 కీ](#api-కీలు)తో ప్రామాణీకరించబడుతుంది — ఒక `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 కీ**ని ఉపయోగిస్తుంది. మీరు కాల్ చేస్తున్న ఉపరితలానికి సరైన ఆధారాన్ని ఎంచుకోండి.

:::

## ఇమెయిల్ డెలివరీ

ఇమెయిల్ డెలివరీ (ఉదాహరణకు, ప్రతిస్పందన నోటిఫికేషన్‌లు) ఇమెయిల్-డెలివరీ ట్యాబ్‌లో **/settings** కింద కాన్ఫిగర్ చేయబడుతుంది. మీరు **ఆరు ప్రొవైడర్‌లలో** దేన్నైనా కనెక్ట్ చేయవచ్చు:

- **Gmail**
- **Resend**
- **SendGrid**
- **Postmark**
- **Amazon SES**
- **కస్టమ్ SMTP**

## తదుపరి దశలు

- [ఒక ఫారమ్‌ను ప్రచురించి షేర్ చేయండి](./publishing-sharing)
- [ప్రతిస్పందనలను చూడండి](./responses)
- [విశ్లేషణలను తెరవండి](./analytics)
- [AIతో ఒక ఫారమ్‌ను రూపొందించండి](./ai-generation)