API ਕਨੈਕਸ਼ਨ
API ਕਨੈਕਸ਼ਨ ਕਸਟਮ HTTP ਫੰਕਸ਼ਨ ਹਨ ਜਿਨ੍ਹਾਂ ਨੂੰ ਤੁਹਾਡੇ ਏਜੰਟ ਗੱਲਬਾਤ ਦੌਰਾਨ
ਕਾਲ ਕਰ ਸਕਦੇ ਹਨ — ਆਰਡਰ ਲੱਭਣ, ਟਿਕਟ ਬਣਾਉਣ, ਜਾਂ ਆਪਣੇ ਬੈਕਐਂਡ ਤੋਂ ਖਾਤੇ ਦੀ ਸਥਿਤੀ
ਪ੍ਰਾਪਤ ਕਰਨ ਲਈ। ਤੁਸੀਂ ਐਂਡਪੌਇੰਟ ਨੂੰ ਇੱਕ ਵਾਰ
ਕਨੈਕਸ਼ਨ → APIs (/dashboard/api-connections) ਹੇਠ ਪਰਿਭਾਸ਼ਿਤ ਕਰਦੇ ਹੋ; ਜਿਨ੍ਹਾਂ
ਏਜੰਟਾਂ ਨਾਲ ਕਨੈਕਸ਼ਨ ਜੋੜਿਆ ਹੋਵੇ, ਉਹ ਗੱਲਬਾਤ ਦੀ ਲੋੜ ਅਨੁਸਾਰ ਇਸਨੂੰ ਕਾਲ ਕਰ ਸਕਦੇ ਹਨ।
ਇਸਨੂੰ ਬਣਾਉਣ ਦੇ ਦੋ ਤਰੀਕੇ ਹਨ: ਵਿਜ਼ਰਡ ਦੁਆਰਾ ਵਿਸ਼ਲੇਸ਼ਿਤ ਕੀਤੀ ਜਾ ਸਕਣ ਵਾਲੀ ਕੋਈ ਚੀਜ਼ ਪੇਸਟ ਕਰੋ ਜਾਂ ਕਨੈਕਸ਼ਨ ਨੂੰ ਹੱਥੋਂ ਸੈੱਟ ਅੱਪ ਕਰੋ।
ਤੇਜ਼ ਤਰੀਕਾ: ਪੇਸਟ ਕਰੋ ਅਤੇ ਵਿਸ਼ਲੇਸ਼ਣ ਕਰੋ
- ਨਵਾਂ API ਕਨੈਕਸ਼ਨ ਕਲਿੱਕ ਕਰੋ
ਡਾਇਲਾਗ ਵਿਜ਼ਰਡ ਵਿੱਚ ਖੁੱਲ੍ਹਦਾ ਹੈ। ਬਾਕਸ ਵਿੱਚ ਇੱਕ ਨਮੂਨਾ cURL ਕਮਾਂਡ, OpenAPI/Swagger ਸਪੈਸਿਫਿਕੇਸ਼ਨ, Postman ਐਕਸਪੋਰਟ, TypeScript ਇੰਟਰਫੇਸ, ਜਾਂ Zod ਸਕੀਮਾ ਪੇਸਟ ਕਰੋ।
- ਵਿਸ਼ਲੇਸ਼ਣ ਕਰੋ ਕਲਿੱਕ ਕਰੋ
ThunderPhone ਤੁਹਾਡੇ ਪੇਸਟ ਤੋਂ ਪੂਰਾ ਕਨੈਕਸ਼ਨ ਅਨੁਮਾਨਿਤ ਕਰਦਾ ਹੈ — URL, ਮੈਥਡ, ਹੈਡਰ, ਅਤੇ ਮਿਲੇ ਕਵੇਰੀ ਪੈਰਾਮੀਟਰਾਂ ਤੇ ਬੇਨਤੀ ਬਾਡੀ ਤੋਂ ਪ੍ਰਾਪਤ ਪੈਰਾਮੀਟਰ ਸਕੀਮਾ। ਤੁਹਾਡੇ ਵੱਲੋਂ ਪੇਸਟ ਕੀਤੇ ਹੈਡਰ (ਪ੍ਰਮਾਣੀਕਰਨ ਹੈਡਰਾਂ ਸਮੇਤ) ਐਂਡਪੌਇੰਟ ਕੌਂਫਿਗਰੇਸ਼ਨ ਵਿੱਚ ਸ਼ਾਮਲ ਹੋ ਜਾਂਦੇ ਹਨ।
- ਹਾਈਲਾਈਟ ਕੀਤੇ ਫੀਲਡਾਂ ਦੀ ਪੁਸ਼ਟੀ ਕਰੋ
ਅਨੁਮਾਨਿਤ ਕੌਂਫਿਗਰੇਸ਼ਨ ਸਮੀਖਿਆ ਲਈ ਅਨੁਮਾਨਿਤ ਫੀਲਡਾਂ ਨੂੰ ਹਾਈਲਾਈਟ ਕਰਕੇ ਖੁੱਲ੍ਹਦੀ ਹੈ। ਨਾਮਾਂ, ਵਰਣਨਾਂ ਅਤੇ ਪੈਰਾਮੀਟਰ ਕਿਸਮਾਂ ਨੂੰ ਢਾਲੋ ਤਾਂ ਜੋ ਏਜੰਟ ਸਮਝ ਸਕੇ ਕਿ ਫੰਕਸ਼ਨ ਨੂੰ ਕਦੋਂ ਅਤੇ ਕਿਵੇਂ ਕਾਲ ਕਰਨਾ ਹੈ — ਵਰਣਨ ਹੀ ਉਹ ਹੈ ਜੋ ਮਾਡਲ ਪੜ੍ਹਦਾ ਹੈ।
- ਪ੍ਰਮਾਣਿਤ ਕਰੋ ਅਤੇ ਸੇਵ ਕਰੋ
ਸੇਵ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਤੁਹਾਡੇ ਐਂਡਪੌਇੰਟ ਵਿਰੁੱਧ ਲਾਈਵ ਟੈਸਟ ਬੇਨਤੀ ਚਲਾਈ ਜਾਂਦੀ ਹੈ। ਜੇ ਬੇਨਤੀ ਅਸਫਲ ਹੋ ਜਾਂਦੀ ਹੈ, ਤਾਂ ਕਨੈਕਸ਼ਨ ਸੇਵ ਨਹੀਂ ਹੁੰਦਾ — URL, ਪ੍ਰਮਾਣੀਕਰਨ ਹੈਡਰਾਂ ਜਾਂ ਬਾਡੀ ਨੂੰ ਠੀਕ ਕਰੋ ਅਤੇ ਦੁਬਾਰਾ ਕੋਸ਼ਿਸ਼ ਕਰੋ। ਸਫਲਤਾ ਉੱਤੇ ਕਨੈਕਸ਼ਨ ਪ੍ਰਮਾਣਿਤ ਬੈਜ ਨਾਲ ਸਟੋਰ ਹੁੰਦਾ ਹੈ।
ਜੇ ਵਿਜ਼ਰਡ ਤੁਹਾਡੇ ਪੇਸਟ ਵਿੱਚ ਬੇਨਤੀ URL ਨਹੀਂ ਲੱਭ ਸਕਦਾ, ਤਾਂ ਇਹ ਤੁਹਾਨੂੰ ਦੱਸੇਗਾ —
ਪੂਰਾ http(s) ਐਂਡਪੌਇੰਟ ਸ਼ਾਮਲ ਕਰੋ ਅਤੇ ਦੁਬਾਰਾ ਕੋਸ਼ਿਸ਼ ਕਰੋ।
ਹੱਥੋਂ ਸੈੱਟਅੱਪ
ਵਿਜ਼ਰਡ ਵਿੱਚ ਹੱਥੋਂ ਸੈੱਟ ਅੱਪ ਕਰੋ → ਕਲਿੱਕ ਕਰੋ (ਜਾਂ ਵਾਪਸ ਜਾਣ ਲਈ ਕੀ ਤੁਸੀਂ ਚਾਹੁੰਦੇ ਹੋ ਕਿ AI ਇਸਦਾ ਅਨੁਮਾਨ ਲਗਾਏ? ਵਿਜ਼ਰਡ ਅਜ਼ਮਾਓ → ਕਲਿੱਕ ਕਰੋ)। ਹੱਥੋਂ ਬਣਾਉਣ ਵਾਲੇ ਵਿੱਚ ਦੋ ਐਡੀਟਰ ਹਨ:
- ਵਿਜ਼ੂਅਲ — ਡਿਸਪਲੇ ਨਾਮ, ਫੰਕਸ਼ਨ ਨਾਮ, ਬੇਨਤੀ
URL, ਮੈਥਡ (
POST,GET,PUT,PATCH,DELETE), ਕਸਟਮ ਹੈਡਰ, ਅਤੇ ਪੈਰਾਮੀਟਰ ਸਕੀਮਾ ਲਈ ਫਾਰਮ ਫੀਲਡ (ਪ੍ਰਾਪਰਟੀ ਸ਼ਾਮਲ ਕਰੋ ਹਰ ਉਸ ਆਰਗੂਮੈਂਟ ਲਈ ਜੋ ਏਜੰਟ ਦੇ ਸਕਦਾ ਹੈ)। - JSON — ਕੱਚੇ JSON ਵਜੋਂ ਉਹੀ ਪਰਿਭਾਸ਼ਾ, ਸਿੱਧੇ ਟੂਲ ਸਪੈਸਿਫਿਕੇਸ਼ਨ ਨੂੰ ਪੇਸਟ ਕਰਨ ਜਾਂ ਸੁਖਮ-ਸੰਰਚਨਾ ਕਰਨ ਲਈ।
ਇੱਕ ਟੈਸਟ ਬੇਨਤੀ ਪੈਨਲ (ਵਿਕਲਪਿਕ) ਤੁਹਾਨੂੰ ਸੇਵ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਕੌਂਫਿਗਰ ਕੀਤੀ ਬੇਨਤੀ ਚਲਾਉਣ ਦਿੰਦਾ ਹੈ ਅਤੇ ਸਥਿਤੀ, ਲੇਟੈਂਸੀ, ਅਤੇ ਜਵਾਬ ਦੀ ਝਲਕ ਦਿਖਾਉਂਦਾ ਹੈ। ਪ੍ਰਮਾਣਿਤ ਕਰੋ ਅਤੇ ਸੇਵ ਕਰੋ ਹਮੇਸ਼ਾ ਇਹ ਟੈਸਟ ਚਲਾਉਂਦਾ ਹੈ ਅਤੇ ਕੇਵਲ ਸਫਲਤਾ ਉੱਤੇ ਸੇਵ ਕਰਦਾ ਹੈ।
ਆਪਣੇ ਕਨੈਕਸ਼ਨਾਂ ਦਾ ਪ੍ਰਬੰਧਨ ਕਰੋ
ਹਰੇਕ ਕਨੈਕਸ਼ਨ ਕਤਾਰ ਇਸਦੀ ਪ੍ਰਮਾਣੀਕਰਨ ਸਥਿਤੀ — ਪ੍ਰਮਾਣਿਤ, ਬਿਨਾਂ ਜਾਂਚਿਆ, ਜਾਂ ਗਲਤੀ — ਇਸਦਾ ਫੰਕਸ਼ਨ ਨਾਮ, ਅਤੇ ਕਿਹੜੇ ਏਜੰਟ ਇਸਨੂੰ ਵਰਤਦੇ ਹਨ, ਦਿਖਾਉਂਦੀ ਹੈ। ਕਤਾਰ ਦੇ ਕਾਰਵਾਈ ਮੇਨੂ ਤੋਂ ਤੁਸੀਂ ਇਹ ਕਰ ਸਕਦੇ ਹੋ:
- ਸੋਧੋ — ਕੌਂਫਿਗਰੇਸ਼ਨ ਮੁੜ ਖੋਲ੍ਹੋ।
- ਕਲੋਨ ਕਰੋ — ਇਸਨੂੰ ਸ਼ੁਰੂਆਤੀ ਬਿੰਦੂ ਵਜੋਂ ਡੁਪਲੀਕੇਟ ਕਰੋ (ਕਾਪੀ ਦੀ ਸ਼ੁਰੂਆਤ ਬਿਨਾਂ ਜਾਂਚਿਆ ਵਜੋਂ ਹੁੰਦੀ ਹੈ)।
- ਰਿਵੀਜ਼ਨ ਇਤਿਹਾਸ — ਪੁਰਾਣੇ ਵਰਜਨ ਵੇਖੋ ਅਤੇ ਇੱਕ ਨੂੰ ਐਡੀਟਰ ਵਿੱਚ ਰੀਸਟੋਰ ਕਰੋ।
- ਟ੍ਰਾਂਸਫ਼ਰ ਕਰੋ — ਕਨੈਕਸ਼ਨ ਨੂੰ ਤੁਹਾਡੇ ਕਿਸੇ ਹੋਰ ਸੰਗਠਨ ਵਿੱਚ ਕਾਪੀ ਜਾਂ ਭੇਜੋ। ਭੇਜਣ ਨਾਲ ਇਹ ਇੱਥੋਂ ਹਟ ਜਾਂਦਾ ਹੈ; ਇਸਨੂੰ ਵਰਤਣ ਵਾਲੇ ਏਜੰਟਾਂ ਨੂੰ ਦੁਬਾਰਾ ਕੌਂਫਿਗਰ ਕਰਨ ਦੀ ਲੋੜ ਪੈ ਸਕਦੀ ਹੈ।
- ਮਿਟਾਓ — ਸਥਾਈ ਤੌਰ ਤੇ; ਕਨੈਕਸ਼ਨ ਵਰਤਣ ਵਾਲੇ ਏਜੰਟਾਂ ਨੂੰ ਦੁਬਾਰਾ ਕੌਂਫਿਗਰ ਕਰਨਾ ਪਵੇਗਾ।
ਇਸਨੂੰ ਏਜੰਟ ਨਾਲ ਜੋੜੋ
ਬਿਲਡਰ ਦੇ API ਕਨੈਕਸ਼ਨ ਭਾਗ ਵਿੱਚ ਏਜੰਟ ਨਾਲ ਕਨੈਕਸ਼ਨ ਜੋੜੋ (ਏਜੰਟ ਬਣਾਓ)। ਸੂਚੀ ਦਿਖਾਉਂਦੀ ਹੈ ਕਿ ਹਰੇਕ ਕਨੈਕਸ਼ਨ ਨੂੰ ਕਿਹੜੇ ਏਜੰਟ ਵਰਤਦੇ ਹਨ, ਤਾਂ ਜੋ ਤੁਸੀਂ ਤੁਰੰਤ ਸਮਝ ਸਕੋ ਕਿ ਕੋਈ ਤਬਦੀਲੀ ਕਿਸ ਉੱਤੇ ਅਸਰ ਕਰਦੀ ਹੈ।