ਸਰਵੇ API ਅਤੇ MCP

imatic Survey ਤੁਹਾਡੇ ਬਾਕੀ ਸਟੈਕ ਨਾਲ ਜੁੜਦਾ ਹੈ — ਜਵਾਬਾਂ ਨੂੰ ਤੁਹਾਡੇ ਆਪਣੇ ਸਿਸਟਮਾਂ ਵੱਲ ਧੱਕਦਾ ਹੈ, ਫਾਰਮ ਦੇ ਕੰਮ ਨੂੰ ਆਟੋਮੇਟ ਕਰਦਾ ਹੈ, ਅਤੇ AI ਏਜੰਟਾਂ ਨੂੰ ਤੁਹਾਡੇ ਫਾਰਮਾਂ ਨਾਲ ਕੰਮ ਕਰਨ ਦਿੰਦਾ ਹੈ। ਇਹ ਪੰਨਾ ਡਿਵੈਲਪਰ ਸਤ੍ਹਾ ਨੂੰ ਕਵਰ ਕਰਦਾ ਹੈ: API ਕੁੰਜੀਆਂ, webhooks, REST API, MCP ਸਰਵਰ, ਅਤੇ ਈਮੇਲ ਡਿਲੀਵਰੀ। ਇਹ ਫੀਚਰ ਅੱਜ ਲਾਈਵ ਹਨ।

ਡਿਵੈਲਪਰ ਖੇਤਰ ਉਹ ਥਾਂ ਹੈ ਜਿੱਥੇ ਤੁਸੀਂ API ਕੁੰਜੀਆਂ, webhooks, ਅਤੇ ਇੰਟੀਗ੍ਰੇਸ਼ਨਾਂ ਦਾ ਪ੍ਰਬੰਧਨ ਕਰਦੇ ਹੋ।

API ਕੁੰਜੀਆਂ

API ਕੁੰਜੀਆਂ ਤੁਹਾਡੀਆਂ ਆਪਣੀਆਂ ਐਪਾਂ ਅਤੇ ਸਕ੍ਰਿਪਟਾਂ ਨੂੰ Survey REST API ਦੇ ਖਿਲਾਫ਼ ਪ੍ਰਮਾਣਿਤ ਕਰਦੀਆਂ ਹਨ। ਇਹਨਾਂ ਨੂੰ /developers/api-keys ਅਧੀਨ ਬਣਾਓ ਅਤੇ ਪ੍ਰਬੰਧਿਤ ਕਰੋ, ਜਿੱਥੇ ਤੁਸੀਂ ਇੱਕ ਕੁੰਜੀ ਜਾਰੀ ਕਰ ਸਕਦੇ ਹੋ, ਇਸ ਨੂੰ ਇੱਕ ਨਾਮ ਦੇ ਸਕਦੇ ਹੋ, ਇਸ ਦੇ ਵਰਤੋਂ ਦੇ ਅੰਕੜੇ ਵੇਖ ਸਕਦੇ ਹੋ, ਅਤੇ ਜੇ ਇਹ ਕਦੇ ਪ੍ਰਗਟ ਹੋ ਜਾਵੇ ਤਾਂ ਇਸ ਨੂੰ ਰੱਦ ਕਰ ਸਕਦੇ ਹੋ।

ਇੱਕ ਕੁੰਜੀ ਪੂਰੀ ਤਰ੍ਹਾਂ ਸਿਰਫ਼ ਇੱਕ ਵਾਰ, ਬਣਾਉਣ ਵੇਲੇ, ਦਿਖਾਈ ਜਾਂਦੀ ਹੈ — ਉਸ ਵੇਲੇ ਇਸ ਨੂੰ ਕਾਪੀ ਕਰੋ ਅਤੇ ਕਿਸੇ ਸੁਰੱਖਿਅਤ ਥਾਂ ਸਟੋਰ ਕਰੋ। ਉਸ ਤੋਂ ਬਾਅਦ ਤੁਸੀਂ ਸੂਚੀ ਵਿੱਚ ਸਿਰਫ਼ ਇਸ ਦਾ ਪ੍ਰੀਫਿਕਸ ਵੇਖੋਗੇ, ਨਾਲ ਹੀ ਇਸ ਦਾ ਨਾਮ, scopes, ਅਤੇ ਆਖਰੀ ਵਾਰ ਵਰਤੋਂ ਦਾ ਸਮਾਂ।

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 ਕੁੰਜੀ ਨੂੰ ਪਾਸਵਰਡ ਵਾਂਗ ਸਮਝੋ। ਇਸ ਨੂੰ ਸੋਰਸ ਕੰਟਰੋਲ ਵਿੱਚ ਕਮਿਟ ਨਾ ਕਰੋ, ਅਤੇ ਜੇ ਤੁਹਾਨੂੰ ਸ਼ੱਕ ਹੋਵੇ ਕਿ ਇਹ ਲੀਕ ਹੋ ਗਈ ਹੈ ਤਾਂ ਇਸ ਨੂੰ ਘੁਮਾਓ (rotate)।

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 ਕੁੰਜੀ ਨਾਲ ਪ੍ਰਮਾਣਿਤ ਹੁੰਦੀ ਹੈ — ਇੱਕ sk_-ਪ੍ਰੀਫਿਕਸ ਵਾਲਾ Bearer token।

AI ਏਜੰਟਾਂ ਲਈ MCP ਸਰਵਰ

MCP ਸਰਵਰ Model Context Protocol ਰਾਹੀਂ Survey ਨੂੰ AI ਏਜੰਟਾਂ ਅੱਗੇ ਪ੍ਰਗਟ ਕਰਦਾ ਹੈ, ਤਾਂ ਜੋ ਇੱਕ ਅਸਿਸਟੈਂਟ ਤੁਹਾਡੀ ਤਰਫ਼ੋਂ ਤੁਹਾਡੇ ਫਾਰਮਾਂ ਅਤੇ ਜਵਾਬਾਂ ਨਾਲ ਕੰਮ ਕਰ ਸਕੇ। ਇਹ POST /mcp ਉੱਤੇ JSON-RPC 2.0 ਬੋਲਦਾ ਹੈ ਅਤੇ ਤੁਹਾਡੇ ਪੋਰਟਲ 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 ਸਰਵਰ ਅਤੇ webhooks ਤੁਹਾਡੇ ਪੋਰਟਲ JWT (org-scoped) ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹਨ। REST API ਉਸ API ਕੁੰਜੀ ਦੀ ਵਰਤੋਂ ਕਰਦੀ ਹੈ ਜੋ ਤੁਸੀਂ /developers/api-keys ਅਧੀਨ ਬਣਾਉਂਦੇ ਹੋ। ਜਿਸ ਸਤ੍ਹਾ ਨੂੰ ਤੁਸੀਂ ਕਾਲ ਕਰ ਰਹੇ ਹੋ, ਉਸ ਲਈ ਸਹੀ ਪ੍ਰਮਾਣ-ਪੱਤਰ ਚੁਣੋ।

ਈਮੇਲ ਡਿਲੀਵਰੀ

ਈਮੇਲ ਡਿਲੀਵਰੀ (ਉਦਾਹਰਨ ਲਈ, ਜਵਾਬ ਨੋਟੀਫਿਕੇਸ਼ਨਾਂ) /settings ਅਧੀਨ ਈਮੇਲ-ਡਿਲੀਵਰੀ ਟੈਬ 'ਤੇ ਕੌਨਫ਼ਿਗਰ ਕੀਤੀ ਜਾਂਦੀ ਹੈ। ਤੁਸੀਂ ਛੇ ਪ੍ਰਦਾਤਾਵਾਂ ਵਿੱਚੋਂ ਕਿਸੇ ਨੂੰ ਵੀ ਜੋੜ ਸਕਦੇ ਹੋ:

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

ਅਗਲੇ ਕਦਮ

• ਇੱਕ ਫਾਰਮ ਪ੍ਰਕਾਸ਼ਿਤ ਕਰੋ ਅਤੇ ਸਾਂਝਾ ਕਰੋ
• ਜਵਾਬ ਵੇਖੋ
• ਵਿਸ਼ਲੇਸ਼ਣ ਖੋਲ੍ਹੋ
• AI ਨਾਲ ਇੱਕ ਫਾਰਮ ਤਿਆਰ ਕਰੋ