Skip to main content

Survey API અને MCP

imatic Survey તમારા બાકીના સ્ટેક સાથે જોડાય છે — પ્રતિસાદોને તમારી પોતાની સિસ્ટમ્સમાં મોકલે છે, ફોર્મનું કામ સ્વયંચાલિત કરે છે, અને AI એજન્ટ્સને તમારા ફોર્મ્સ સાથે કામ કરવા દે છે. આ પેજ ડેવલપર સરફેસને આવરી લે છે: API keys, webhooks, REST API, MCP server, અને email ડિલિવરી. આ સુવિધાઓ આજે લાઈવ છે.

integrations અને ડેવલપર સેટિંગ્સ ક્ષેત્ર ડેવલપર ક્ષેત્ર એ છે જ્યાં તમે API keys, webhooks, અને integrations મેનેજ કરો છો.

API keys​

API keys તમારી પોતાની એપ્સ અને સ્ક્રિપ્ટ્સને Survey REST API સામે પ્રમાણિત કરે છે. તેમને /developers/api-keys હેઠળ બનાવો અને મેનેજ કરો, જ્યાં તમે કી જારી કરી શકો છો, તેને નામ આપી શકો છો, તેના વપરાશ આંકડા જોઈ શકો છો, અને જો તે ક્યારેય ઉઘાડી પડે તો તેને રદ કરી શકો છો.

કી સંપૂર્ણ સ્વરૂપે ફક્ત એક જ વાર બતાવાય છે, બનાવતી વખતે — ત્યારે જ તેને કૉપિ કરો અને ક્યાંક સલામત જગ્યાએ સંગ્રહો. તે પછી તમે યાદીમાં ફક્ત તેનો પ્રિફિક્સ જોશો, તેના નામ, સ્કોપ્સ, અને છેલ્લે-વપરાયેલ સમય સાથે.

API https://surveyapi.imatic.ai પર હોસ્ટ થયેલ છે, અને કી sk_-પ્રિફિક્સવાળી હોય છે. તમારી કીને Bearer ટોકન તરીકે મોકલો. એન્ડપોઈન્ટ્સ કસ્ટમ-વર્બ POST વિનંતીઓ છે — ઉદાહરણ તરીકે, તમારા ફોર્મ્સની યાદી બનાવવા માટે:

curl -X POST https://surveyapi.imatic.ai/forms/list \
  -H "Authorization: Bearer sk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
કી ગુપ્ત રાખો

API key ને પાસવર્ડની જેમ ગણો. તેને સોર્સ કંટ્રોલમાં કમિટ ન કરો, અને જો તમને શંકા હોય કે તે લીક થઈ ગઈ છે તો તેને રોટેટ કરો.

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 તમને ફોર્મ્સ અને પ્રતિસાદોને પ્રોગ્રામેટિક રીતે મેનેજ કરવા દે છે. એન્ડપોઈન્ટ્સ વર્ઝન્ડ પાથ પ્રિફિક્સને બદલે કસ્ટમ-વર્બ 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 વડે પ્રમાણિત થાય છે — એક sk_-પ્રિફિક્સવાળો Bearer ટોકન.

AI એજન્ટ્સ માટે MCP server​

MCP server Model Context Protocol દ્વારા Survey ને 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 — લાઈવ પોલ ગણતરી વાંચો.
બે અલગ ઓળખપત્રો

MCP server અને webhooks તમારા પોર્ટલ JWT (org-scoped) નો ઉપયોગ કરે છે. REST API તમે /developers/api-keys હેઠળ બનાવેલ API key નો ઉપયોગ કરે છે. તમે જે સરફેસ કૉલ કરી રહ્યા છો તેના માટે યોગ્ય ઓળખપત્ર પસંદ કરો.

Email ડિલિવરી​

Email ડિલિવરી (ઉદાહરણ તરીકે, પ્રતિસાદ સૂચનાઓ) /settings હેઠળ email-delivery ટેબ પર રૂપરેખાંકિત થાય છે. તમે આમાંથી કોઈ પણ છ પ્રોવાઇડર્સ જોડી શકો છો:

  • Gmail
  • Resend
  • SendGrid
  • Postmark
  • Amazon SES
  • કસ્ટમ SMTP

આગળનાં પગલાં​