API ਕੀ ਹੈ? ਐਪ ਬਿਲਡਰਾਂ ਲਈ ਸਰਲ ਗਾਈਡ
API (ਐਪਲੀਕੇਸ਼ਨ ਪ੍ਰੋਗਰਾਮਿੰਗ ਇੰਟਰਫ਼ੇਸ) ਇੱਕ ਤੈਅ ਤਰੀਕਾ ਹੈ ਜਿਸ ਨਾਲ ਇੱਕ ਸੌਫ਼ਟਵੇਅਰ ਦੂਜੇ ਤੋਂ ਡੇਟਾ ਮੰਗਦਾ ਹੈ ਜਾਂ ਉਸਨੂੰ ਕੁਝ ਕਰਨ ਲਈ ਕਹਿੰਦਾ ਹੈ। ਤੁਹਾਡੀ ਐਪ ਇੱਕ ਸਹਿਮਤ ਫ਼ਾਰਮੈਟ ਵਿੱਚ ਬੇਨਤੀ ਭੇਜਦੀ ਹੈ — “ਮੈਨੂੰ ਕੱਲ੍ਹ ਦੀਆਂ ਬੁਕਿੰਗਾਂ ਦਿਓ,” “ਇਸ ਕਾਰਡ ਤੋਂ €20 ਲਓ,” “ਇਸ ਟੈਕਸਟ ਦਾ ਸਾਰ ਦਿਓ” — ਅਤੇ ਦੂਜਾ ਸਿਸਟਮ ਇੱਕ ਬਣਤਰ ਵਾਲਾ ਜਵਾਬ ਭੇਜਦਾ ਹੈ। API ਹੀ ਉਹ ਤਰੀਕਾ ਹੈ ਜਿਸ ਨਾਲ ਐਪ ਦੇ ਹਿੱਸੇ ਇੱਕ-ਦੂਜੇ ਨਾਲ ਗੱਲ ਕਰਦੇ ਹਨ, ਅਤੇ ਜਿਸ ਰਾਹੀਂ ਤੁਹਾਡੀ ਐਪ ਭੁਗਤਾਨ, ਈਮੇਲ, ਨਕਸ਼ੇ ਅਤੇ AI ਵਰਗੀਆਂ ਬਾਹਰੀ ਸੇਵਾਵਾਂ ਵਰਤਦੀ ਹੈ।
AI ਨਾਲ ਬਣਾਉਂਦੇ ਸਮੇਂ API ਕਿਉਂ ਮਾਇਨੇ ਰੱਖਦੇ ਹਨ
ਲਗਭਗ ਹਰ ਲਾਭਦਾਇਕ ਐਪ ਉਹਨਾਂ ਹਿੱਸਿਆਂ ਨਾਲ ਬਣੀ ਹੁੰਦੀ ਹੈ ਜੋ API ਰਾਹੀਂ ਗੱਲ ਕਰਦੇ ਹਨ:
- ਤੁਹਾਡੀ ਐਪ ਦੇ ਅੰਦਰ, ਬਰਾਊਜ਼ਰ ਦੀਆਂ ਸਕਰੀਨਾਂ ਡੇਟਾ ਲੋਡ ਅਤੇ ਸੇਵ ਕਰਨ ਲਈ ਤੁਹਾਡੇ ਆਪਣੇ ਬੈਕਐਂਡ ਦੇ API ਨੂੰ ਕਾਲ ਕਰਦੀਆਂ ਹਨ।
- ਤੁਹਾਡੀ ਐਪ ਦੇ ਬਾਹਰ, ਤੁਹਾਡਾ ਬੈਕਐਂਡ ਹੋਰ ਕੰਪਨੀਆਂ ਦੇ API ਕਾਲ ਕਰਦਾ ਹੈ: ਭੁਗਤਾਨ ਲੈਣ ਲਈ Stripe, ਰਸੀਦਾਂ ਭੇਜਣ ਲਈ ਇੱਕ ਈਮੇਲ ਪ੍ਰਦਾਤਾ, ਟੈਕਸਟ ਬਣਾਉਣ ਲਈ ਇੱਕ AI ਮਾਡਲ ਪ੍ਰਦਾਤਾ।
ਜਦੋਂ ਤੁਸੀਂ ਕਿਸੇ AI ਬਿਲਡਰ ਨੂੰ “ਭੁਗਤਾਨ ਲਓ” ਜਾਂ “AI ਸਾਰ ਜੋੜੋ” ਕਹਿੰਦੇ ਹੋ, ਤਾਂ ਅਸਲ ਵਿੱਚ ਉਹ ਇੱਕ API ਕਾਲ ਕਰਨ ਵਾਲਾ ਕੋਡ ਲਿਖ ਰਿਹਾ ਹੁੰਦਾ ਹੈ। ਬੁਨਿਆਦੀ ਗੱਲਾਂ ਜਾਣਨ ਨਾਲ ਤੁਸੀਂ ਸਮਝ ਸਕਦੇ ਹੋ ਕਿ AI ਨੂੰ ਤੁਹਾਡੇ ਤੋਂ ਕੀ ਚਾਹੀਦਾ ਹੈ (ਆਮ ਤੌਰ 'ਤੇ ਉਸ ਸੇਵਾ ਵਿੱਚ ਖਾਤਾ ਅਤੇ ਇੱਕ API ਕੀ), ਕਿੱਥੇ ਗੜਬੜ ਹੋ ਸਕਦੀ ਹੈ, ਅਤੇ ਇਸਦਾ ਖ਼ਰਚ ਕਿੰਨਾ ਹੋਵੇਗਾ।
ਰੋਜ਼ਾਨਾ ਦੀ ਮਿਸਾਲ
ਇੱਕ ਰੈਸਟੋਰੈਂਟ ਬਾਰੇ ਸੋਚੋ। ਤੁਸੀਂ ਰਸੋਈ ਵਿੱਚ ਜਾ ਕੇ ਖਾਣਾ ਨਹੀਂ ਬਣਾਉਂਦੇ। ਤੁਸੀਂ ਮੀਨੂ ਪੜ੍ਹਦੇ ਹੋ, ਵੇਟਰ ਨੂੰ ਉਹ ਚੀਜ਼ ਇਸ ਤਰ੍ਹਾਂ ਦੱਸਦੇ ਹੋ ਜੋ ਰਸੋਈ ਸਮਝੇ, ਅਤੇ ਵੇਟਰ ਤੁਹਾਡਾ ਖਾਣਾ ਲਿਆਉਂਦਾ ਹੈ — ਜਾਂ ਦੱਸਦਾ ਹੈ ਕਿ ਉਹ ਪਕਵਾਨ ਖ਼ਤਮ ਹੋ ਗਿਆ ਹੈ।
- ਮੀਨੂ API ਦਾ ਦਸਤਾਵੇਜ਼ ਹੈ: ਕੀ ਮੰਗਿਆ ਜਾ ਸਕਦਾ ਹੈ ਅਤੇ ਕਿਵੇਂ ਦੀ ਸੂਚੀ।
- ਵੇਟਰ API ਹੈ: ਬੇਨਤੀਆਂ ਅੰਦਰ ਜਾਣ ਅਤੇ ਜਵਾਬ ਬਾਹਰ ਆਉਣ ਦਾ ਇੱਕ ਤੈਅ ਤਰੀਕਾ।
- ਰਸੋਈ ਦੂਜਾ ਸਿਸਟਮ ਹੈ: ਤੁਹਾਨੂੰ ਅੰਦਰ ਕਿਵੇਂ ਕੰਮ ਕਰਦਾ ਹੈ ਇਹ ਜਾਣਨ ਦੀ ਲੋੜ ਨਹੀਂ।
- ਤੁਹਾਡਾ ਆਰਡਰ ਬੇਨਤੀ ਹੈ; ਪਲੇਟ ਜਵਾਬ ਹੈ।
ਰਸੋਈ ਆਪਣੇ ਓਵਨ ਅਤੇ ਸਟਾਫ਼ ਬਦਲ ਸਕਦੀ ਹੈ ਬਿਨਾਂ ਤੁਹਾਡਾ ਕੁਝ ਵਿਗਾੜੇ, ਜਿੰਨਾ ਚਿਰ ਮੀਨੂ ਉਹੀ ਰਹੇ। API ਦੀ ਅਸਲ ਕੀਮਤ ਇਹੀ ਹੈ: ਇਹ ਦੋ ਸਿਸਟਮਾਂ ਨੂੰ ਇਕੱਠੇ ਕੰਮ ਕਰਨ ਦਿੰਦਾ ਹੈ, ਬਿਨਾਂ ਇਹ ਜਾਣੇ ਕਿ ਦੂਜਾ ਅੰਦਰੋਂ ਕਿਵੇਂ ਬਣਿਆ ਹੈ।
ਵੈੱਬ API ਬੇਨਤੀ ਕਿਵੇਂ ਕੰਮ ਕਰਦੀ ਹੈ
ਜ਼ਿਆਦਾਤਰ API ਜੋ ਤੁਸੀਂ ਵੇਖੋਗੇ ਉਹ ਵੈੱਬ API ਹਨ ਜੋ HTTP 'ਤੇ ਚੱਲਦੇ ਹਨ, ਉਹੀ ਪ੍ਰੋਟੋਕੋਲ ਜੋ ਤੁਹਾਡਾ ਬਰਾਊਜ਼ਰ ਵਰਤਦਾ ਹੈ। ਹਰ ਬੇਨਤੀ ਦੇ ਕੁਝ ਹਿੱਸੇ ਹੁੰਦੇ ਹਨ:
| ਹਿੱਸਾ | ਇਹ ਕੀ ਹੈ | ਮਿਸਾਲ |
|---|---|---|
| ਤਰੀਕਾ | ਕਾਰਵਾਈ ਦੀ ਕਿਸਮ | GET (ਪੜ੍ਹਨਾ), POST (ਬਣਾਉਣਾ) |
| URL / ਐਂਡਪੌਇੰਟ | ਉਸ ਚੀਜ਼ ਦਾ ਪਤਾ ਜਿਸ 'ਤੇ ਤੁਸੀਂ ਕਾਰਵਾਈ ਕਰਦੇ ਹੋ | https://api.example.com/bookings |
| ਹੈਡਰ | ਵਾਧੂ ਜਾਣਕਾਰੀ, ਜਿਸ ਵਿੱਚ ਤੁਸੀਂ ਕੌਣ ਹੋ ਵੀ ਸ਼ਾਮਲ ਹੈ | Authorization: Bearer <your key> |
| ਬਾਡੀ | ਉਹ ਡੇਟਾ ਜੋ ਤੁਸੀਂ ਭੇਜਦੇ ਹੋ, ਬਣਾਉਣ ਅਤੇ ਅੱਪਡੇਟ ਲਈ | {"name": "Lena", "time": "14:00"} |
ਅਤੇ ਹਰ ਜਵਾਬ ਵਿੱਚ ਹੁੰਦਾ ਹੈ:
| ਹਿੱਸਾ | ਇਹ ਕੀ ਹੈ | ਮਿਸਾਲ |
|---|---|---|
| ਸਟੇਟਸ ਕੋਡ | ਇੱਕ ਨੰਬਰ ਜੋ ਦੱਸਦਾ ਹੈ ਕਿ ਕੀ ਹੋਇਆ | 200 OK, 201 ਬਣਾਇਆ ਗਿਆ, 404 ਨਹੀਂ ਮਿਲਿਆ |
| ਬਾਡੀ | ਵਾਪਸ ਆਇਆ ਡੇਟਾ, ਆਮ ਤੌਰ 'ਤੇ JSON ਵਿੱਚ | {"id": 5001, "status": "confirmed"} |
JSON (JavaScript Object Notation) ਨਾਵਾਂ ਅਤੇ ਮੁੱਲਾਂ ਦਾ ਸਾਦਾ ਟੈਕਸਟ ਫ਼ਾਰਮੈਟ ਹੈ ਜੋ ਕਰਲੀ ਬਰੈਕਟਾਂ ਵਿੱਚ ਹੁੰਦਾ ਹੈ। ਵੈੱਬ API ਡੇਟਾ ਦੇ ਆਦਾਨ-ਪ੍ਰਦਾਨ ਲਈ ਇਹ ਮਿਆਰੀ ਤਰੀਕਾ ਹੈ।
REST: ਸਭ ਤੋਂ ਆਮ ਢੰਗ
REST ਵੈੱਬ API ਡਿਜ਼ਾਈਨ ਕਰਨ ਦਾ ਵਿਆਪਕ ਤੌਰ 'ਤੇ ਵਰਤਿਆ ਜਾਂਦਾ ਨਿਯਮ ਹੈ। ਹਰ ਕਿਸਮ ਦੀ ਚੀਜ਼ ਦਾ ਆਪਣਾ URL ਹੁੰਦਾ ਹੈ, ਅਤੇ ਮਿਆਰੀ ਤਰੀਕੇ ਦੱਸਦੇ ਹਨ ਕਿ ਤੁਸੀਂ ਉਸ ਨਾਲ ਕੀ ਕਰ ਰਹੇ ਹੋ। ਇੱਕ ਬੁਕਿੰਗ ਐਪ ਲਈ REST API ਇਸ ਤਰ੍ਹਾਂ ਦਿਸ ਸਕਦਾ ਹੈ:
| ਤਰੀਕਾ | ਐਂਡਪੌਇੰਟ | ਕੀ ਕਰਦਾ ਹੈ |
|---|---|---|
GET | /api/bookings | ਬੁਕਿੰਗਾਂ ਦੀ ਸੂਚੀ |
GET | /api/bookings/5001 | ਇੱਕ ਬੁਕਿੰਗ ਲੈਣਾ |
POST | /api/bookings | ਨਵੀਂ ਬੁਕਿੰਗ ਬਣਾਉਣਾ |
PATCH | /api/bookings/5001 | ਬੁਕਿੰਗ ਦਾ ਕੁਝ ਹਿੱਸਾ ਬਦਲਣਾ, ਜਿਵੇਂ ਸਮਾਂ |
DELETE | /api/bookings/5001 | ਬੁਕਿੰਗ ਰੱਦ (ਹਟਾਉਣਾ) ਕਰਨਾ |
PUT ਵੀ ਮੌਜੂਦ ਹੈ ਅਤੇ ਆਮ ਤੌਰ 'ਤੇ ਪੂਰਾ ਰਿਕਾਰਡ ਬਦਲਦਾ ਹੈ, ਜਦਕਿ PATCH ਸਿਰਫ਼ ਉਹੀ ਖੇਤਰ ਬਦਲਦਾ ਹੈ ਜੋ ਤੁਸੀਂ ਭੇਜਦੇ ਹੋ।
ਸਭ ਤੋਂ ਵੱਧ ਦਿਸਣ ਵਾਲੇ ਸਟੇਟਸ ਕੋਡ:
| ਕੋਡ | ਮਤਲਬ |
|---|---|
200 / 201 | ਸਫ਼ਲਤਾ / ਬਣਾਇਆ ਗਿਆ |
400 | ਖ਼ਰਾਬ ਬੇਨਤੀ — ਜੋ ਤੁਸੀਂ ਭੇਜਿਆ ਉਸ ਵਿੱਚ ਕੁਝ ਗ਼ਲਤ ਜਾਂ ਗ਼ੈਰ-ਹਾਜ਼ਰ ਸੀ |
401 | ਪ੍ਰਮਾਣਿਤ ਨਹੀਂ — ਕੋਈ ਠੀਕ ਲੌਗਇਨ ਜਾਂ ਕੀ ਨਹੀਂ |
403 | ਵਰਜਿਤ — ਤੁਸੀਂ ਜਾਣੇ ਜਾਂਦੇ ਹੋ, ਪਰ ਇਹ ਕਰਨ ਦੀ ਇਜਾਜ਼ਤ ਨਹੀਂ |
404 | ਨਹੀਂ ਮਿਲਿਆ |
429 | ਬਹੁਤ ਸਾਰੀਆਂ ਬੇਨਤੀਆਂ — ਤੁਸੀਂ ਰੇਟ ਲਿਮਿਟ ਤੱਕ ਪਹੁੰਚ ਗਏ |
500 | ਸਰਵਰ ਵਿੱਚ ਗ਼ਲਤੀ ਆਈ |
ਜਦੋਂ ਤੁਹਾਡੀ ਐਪ ਟੁੱਟਦੀ ਹੈ, ਤਾਂ ਸਟੇਟਸ ਕੋਡ ਅਕਸਰ ਸਭ ਤੋਂ ਤੇਜ਼ ਸੁਰਾਗ਼ ਹੁੰਦਾ ਹੈ। ਕਿਸੇ ਭੁਗਤਾਨ ਪ੍ਰਦਾਤਾ ਤੋਂ 401 ਆਮ ਤੌਰ 'ਤੇ ਗ਼ੈਰ-ਹਾਜ਼ਰ ਜਾਂ ਗ਼ਲਤ API ਕੀ ਦਾ ਮਤਲਬ ਹੁੰਦਾ ਹੈ; 429 ਦਾ ਮਤਲਬ ਹੈ ਤੁਸੀਂ ਬਹੁਤ ਵਾਰ ਕਾਲ ਕਰ ਰਹੇ ਹੋ।
REST ਹੀ ਇਕੋ ਢੰਗ ਨਹੀਂ ਹੈ — GraphQL ਅਤੇ RPC-ਸ਼ੈਲੀ ਦੇ API ਵੀ ਹਨ — ਪਰ ਜ਼ਿਆਦਾਤਰ ਸੇਵਾਵਾਂ ਅਤੇ AI ਨਾਲ ਬਣੇ ਬੈਕਐਂਡ REST ਹੀ ਵਰਤਦੇ ਹਨ।
ਇੱਕ ਕੰਮ ਕੀਤੀ ਮਿਸਾਲ: ਬੁਕਿੰਗ ਦੀ ਪੁਸ਼ਟੀ
ਜਦੋਂ ਕੋਈ ਗਾਹਕ ਸੈਲੂਨ ਐਪ ਵਿੱਚ ਵਾਲ ਕਟਵਾਉਣ ਦੀ ਬੁਕਿੰਗ ਕਰਦਾ ਹੈ, ਤਾਂ ਇੱਕ-ਦੋ ਸਕਿੰਟਾਂ ਵਿੱਚ ਕਈ API ਕਾਲਾਂ ਹੋ ਸਕਦੀਆਂ ਹਨ:
- ਬਰਾਊਜ਼ਰ ਵਿਚਲਾ ਬੁਕਿੰਗ ਪੰਨਾ ਸੇਵਾ, ਸਮਾਂ ਅਤੇ ਗਾਹਕ ਦੇ ਵੇਰਵੇ ਨਾਲ
POST /api/bookingsਤੁਹਾਡੇ ਬੈਕਐਂਡ ਨੂੰ ਭੇਜਦਾ ਹੈ। - ਤੁਹਾਡਾ ਬੈਕਐਂਡ ਜਾਂਚਦਾ ਹੈ ਕਿ ਸਲਾਟ ਖਾਲੀ ਹੈ, ਬੁਕਿੰਗ ਨੂੰ ਡੇਟਾਬੇਸ ਵਿੱਚ ਸੇਵ ਕਰਦਾ ਹੈ, ਅਤੇ
201 Createdਵਾਪਸ ਕਰਦਾ ਹੈ। - ਤੁਹਾਡਾ ਬੈਕਐਂਡ ਆਪਣੀ ਸੀਕ੍ਰੇਟ ਕੀ ਨਾਲ ਈਮੇਲ ਪ੍ਰਦਾਤਾ ਦੇ API ਨੂੰ ਕਾਲ ਕਰਦਾ ਹੈ: “ਇਹ ਪੁਸ਼ਟੀ lena@example.com ਨੂੰ ਭੇਜੋ।”
- ਜੇ ਕੋਈ ਐਡਵਾਂਸ ਹੋਵੇ, ਤਾਂ ਤੁਹਾਡਾ ਬੈਕਐਂਡ ਭੁਗਤਾਨ ਪ੍ਰਦਾਤਾ ਦੇ API ਤੋਂ ਚੈੱਕਆਊਟ ਸੈਸ਼ਨ ਬਣਵਾਉਂਦਾ ਹੈ ਅਤੇ ਗਾਹਕ ਨੂੰ ਉੱਥੇ ਭੇਜਦਾ ਹੈ।
- ਬਾਅਦ ਵਿੱਚ, ਭੁਗਤਾਨ ਪ੍ਰਦਾਤਾ ਤੁਹਾਡੀ ਐਪ ਨੂੰ ਕਾਲ ਕਰਕੇ ਦੱਸਦਾ ਹੈ ਕਿ ਭੁਗਤਾਨ ਸਫ਼ਲ ਹੋਇਆ। ਇਹ ਉਲਟੀ ਕਾਲ ਇੱਕ ਵੈੱਬਹੁੱਕ ਹੈ।
ਪਹਿਲੇ ਦੋ ਕਦਮ ਫ਼ਰੰਟਐਂਡ ਅਤੇ ਬੈਕਐਂਡ ਵਿਚਕਾਰ ਤੁਹਾਡਾ ਆਪਣਾ API ਹਨ। ਕਦਮ 3–5 ਤੀਜੀ-ਧਿਰ API ਹਨ।
ਆਮ ਸ਼ਬਦਾਂ ਦੀ ਵਿਆਖਿਆ
| ਸ਼ਬਦ | ਮਤਲਬ |
|---|---|
| ਐਂਡਪੌਇੰਟ | ਇੱਕ ਖ਼ਾਸ URL ਜਿਸ 'ਤੇ API ਜਵਾਬ ਦਿੰਦਾ ਹੈ। |
| API ਕੀ | ਇੱਕ ਗੁਪਤ ਸਤਰ ਜੋ ਤੁਹਾਡੀ ਐਪ ਨੂੰ ਕਿਸੇ ਸੇਵਾ ਲਈ ਪਛਾਣਦੀ ਹੈ। ਇਸਨੂੰ ਪਾਸਵਰਡ ਵਾਂਗ ਸਮਝੋ। |
| ਪ੍ਰਮਾਣੀਕਰਨ | ਸਾਬਤ ਕਰਨਾ ਕਿ ਕੌਣ ਕਾਲ ਕਰ ਰਿਹਾ ਹੈ — ਕੀ, ਟੋਕਨ ਜਾਂ ਲੌਗਇਨ ਨਾਲ। ਵੇਖੋ ਪ੍ਰਮਾਣੀਕਰਨ ਕੀ ਹੈ। |
| ਰੇਟ ਲਿਮਿਟ | ਇੱਕ ਸਮੇਂ ਵਿੱਚ ਤੁਸੀਂ ਕਿੰਨੀਆਂ ਬੇਨਤੀਆਂ ਕਰ ਸਕਦੇ ਹੋ, ਉਸ ਦੀ ਹੱਦ। |
| SDK | ਤਿਆਰ ਕੋਡ ਲਾਇਬ੍ਰੇਰੀ ਜੋ ਕਿਸੇ ਖ਼ਾਸ API ਨੂੰ ਕਾਲ ਕਰਨਾ ਆਸਾਨ ਬਣਾਉਂਦੀ ਹੈ। |
| ਦਸਤਾਵੇਜ਼ | “ਮੀਨੂ”: ਕਿਹੜੇ ਐਂਡਪੌਇੰਟ ਹਨ, ਉਹ ਕੀ ਲੈਂਦੇ ਅਤੇ ਕੀ ਵਾਪਸ ਕਰਦੇ ਹਨ। |
| ਸੈਂਡਬਾਕਸ / ਟੈਸਟ ਮੋਡ | ਕਿਸੇ ਸੇਵਾ ਦਾ ਉਹ ਵਰਜ਼ਨ ਜੋ ਅਸਲ ਪੈਸੇ ਜਾਂ ਡੇਟਾ ਤੋਂ ਬਿਨਾਂ ਟੈਸਟਿੰਗ ਲਈ ਹੈ। |
| ਵੈੱਬਹੁੱਕ | ਕੁਝ ਹੋਣ 'ਤੇ ਕਿਸੇ ਹੋਰ ਸੇਵਾ ਵੱਲੋਂ ਤੁਹਾਡੀ ਐਪ ਵਿੱਚ ਕੀਤੀ ਕਾਲ। |
ਆਮ ਗ਼ਲਤੀਆਂ ਅਤੇ ਗ਼ਲਤਫ਼ਹਿਮੀਆਂ
- ਫ਼ਰੰਟਐਂਡ ਵਿੱਚ ਸੀਕ੍ਰੇਟ ਕੀਜ਼ ਪਾਉਣਾ। ਬਰਾਊਜ਼ਰ ਵਿੱਚ ਚੱਲਣ ਵਾਲੇ ਕੋਡ ਵਿੱਚ ਕੁਝ ਵੀ ਕੋਈ ਵੀ ਵਿਜ਼ਿਟਰ ਵੇਖ ਸਕਦਾ ਹੈ। ਸੀਕ੍ਰੇਟ ਕੀਜ਼ ਸਰਵਰ 'ਤੇ ਰਹਿਣੀਆਂ ਚਾਹੀਦੀਆਂ ਹਨ, ਇਨਵਾਇਰਨਮੈਂਟ ਵੇਰੀਏਬਲਾਂ ਜਾਂ ਸੀਕ੍ਰੇਟਸ ਵਿੱਚ।
- ਚੈਟ ਵਿੱਚ ਕੀਜ਼ ਪੇਸਟ ਕਰਨਾ। ਚੈਟ ਇਤਿਹਾਸ ਸੰਭਾਲਿਆ ਜਾ ਸਕਦਾ ਹੈ। ਇਸ ਦੀ ਥਾਂ ਆਪਣੇ ਬਿਲਡਰ ਦੀ ਸੀਕ੍ਰੇਟ ਸੁਵਿਧਾ ਵਰਤੋ, ਅਤੇ ਜਿਸ ਕੀ ਦਾ ਖ਼ੁਲਾਸਾ ਹੋ ਗਿਆ ਹੋਵੇ ਉਸਨੂੰ ਬਦਲ ਦਿਓ।
- ਮੰਨ ਲੈਣਾ ਕਿ API ਮੁਫ਼ਤ ਹੈ। ਬਹੁਤ ਸਾਰੇ API ਪ੍ਰਤੀ ਬੇਨਤੀ ਜਾਂ ਵਰਤੋਂ ਦੀ ਇਕਾਈ ਅਨੁਸਾਰ ਪੈਸੇ ਲੈਂਦੇ ਹਨ — AI ਮਾਡਲ API ਟੋਕਨਾਂ ਅਨੁਸਾਰ ਚਾਰਜ ਕਰਦੇ ਹਨ। ਕੀਮਤ ਜਾਂਚੋ ਅਤੇ ਖ਼ਰਚ ਦੀਆਂ ਹੱਦਾਂ ਲਾਓ। ਵੇਖੋ LLM API ਕਿਵੇਂ ਵਰਤਣੇ ਹਨ।
- ਅਸਫ਼ਲਤਾ ਨੂੰ ਨਾ ਸੰਭਾਲਣਾ। ਬਾਹਰੀ ਸੇਵਾਵਾਂ ਬੰਦ ਹੋ ਜਾਂਦੀਆਂ ਹਨ, ਟਾਈਮਆਊਟ ਹੁੰਦੀਆਂ ਹਨ ਅਤੇ ਹੱਦਾਂ ਤੱਕ ਪਹੁੰਚਦੀਆਂ ਹਨ। ਸਹੀ ਗ਼ਲਤੀ ਸੁਨੇਹੇ ਅਤੇ ਦੁਬਾਰਾ ਕੋਸ਼ਿਸ਼ ਮੰਗੋ।
- ਬਰਾਊਜ਼ਰ 'ਤੇ ਭਰੋਸਾ ਕਰਨਾ। ਤੁਹਾਡੇ ਆਪਣੇ API ਨੂੰ ਆਪ ਇਜਾਜ਼ਤਾਂ ਜਾਂਚਣੀਆਂ ਚਾਹੀਦੀਆਂ ਹਨ। ਬਟਨ ਲੁਕਾਉਣ ਨਾਲ ਕੋਈ ਸਿੱਧੀ ਐਂਡਪੌਇੰਟ ਕਾਲ ਕਰਨ ਤੋਂ ਨਹੀਂ ਰੁਕਦਾ।
- ਟੈਸਟਿੰਗ ਦੌਰਾਨ ਲਾਈਵ ਕੀਜ਼ ਵਰਤਣਾ। ਲਾਂਚ ਲਈ ਤਿਆਰ ਹੋਣ ਤੱਕ ਟੈਸਟ ਮੋਡ ਦੀਆਂ ਕੀਜ਼ ਵਰਤੋ।
ਆਪਣੇ AI ਬਿਲਡਰ ਤੋਂ ਕੀ ਮੰਗਣਾ ਹੈ
- "ਇਹ ਐਪ ਕਿਹੜੇ ਬਾਹਰੀ API ਵਰਤਦੀ ਹੈ, ਅਤੇ ਹਰ ਇੱਕ ਦੀ ਕੀਮਤ ਕਿੰਨੀ ਹੈ?"
- "ਭੁਗਤਾਨ API ਸਿਰਫ਼ ਸਰਵਰ ਤੋਂ ਕਾਲ ਕਰੋ। ਕੀ ਇਨਵਾਇਰਨਮੈਂਟ ਵੇਰੀਏਬਲ ਤੋਂ ਪੜ੍ਹੋ।"
- "ਸਾਡੇ API ਦਾ ਹਰ ਐਂਡਪੌਇੰਟ ਸੂਚੀਬੱਧ ਕਰੋ, ਉਹ ਕੀ ਕਰਦਾ ਹੈ ਅਤੇ ਉਸਨੂੰ ਕੌਣ ਕਾਲ ਕਰ ਸਕਦਾ ਹੈ।"
- "ਅੱਪਡੇਟ ਜਾਂ ਮਿਟਾਉਣ ਤੋਂ ਪਹਿਲਾਂ ਸਰਵਰ 'ਤੇ ਜਾਂਚੋ ਕਿ ਲੌਗਇਨ ਕੀਤਾ ਯੂਜ਼ਰ ਬੁਕਿੰਗ ਦਾ ਮਾਲਕ ਹੈ।"
- "ਜੇ ਈਮੇਲ API ਫ਼ੇਲ੍ਹ ਹੋਵੇ, ਤਾਂ ਵੀ ਬੁਕਿੰਗ ਸੇਵ ਕਰੋ ਅਤੇ ਗ਼ਲਤੀ ਲੌਗ ਕਰੋ।"
- "ਫ਼ਿਲਹਾਲ ਪ੍ਰਦਾਤਾ ਦਾ ਟੈਸਟ ਮੋਡ ਵਰਤੋ।"
Mythex ਵਿੱਚ API
Mythex ਤੁਹਾਡਾ ਆਪਣਾ API ਬਣਾ ਸਕਦਾ ਹੈ — ਇੱਕ ਵੈੱਬ ਐਪ ਦੇ ਹਿੱਸੇ ਵਜੋਂ, ਜਾਂ ਫ਼ਰੰਟਐਂਡ ਨਾਲ ਚੱਲਣ ਵਾਲੇ ਇੱਕ ਵੱਖਰੇ ਬੈਕਐਂਡ ਵਜੋਂ Node, Python (FastAPI), C# ਜਾਂ Java ਵਿੱਚ — ਅਤੇ ਬਾਹਰੀ ਸੇਵਾਵਾਂ ਨੂੰ ਕਾਲ ਕਰਨ ਵਾਲਾ ਕੋਡ ਲਿਖ ਸਕਦਾ ਹੈ। ਤੁਸੀਂ ਉਹਨਾਂ ਦੀਆਂ ਕੀਜ਼ ਚੈਟ ਵਿੱਚ ਨਹੀਂ, ਪ੍ਰੋਜੈਕਟ ਸੀਕ੍ਰੇਟਸ ਵਜੋਂ ਜੋੜਦੇ ਹੋ, ਅਤੇ ਉਹ ਪ੍ਰੀਵਿਊ ਵਿੱਚ ਅਤੇ ਪ੍ਰਕਾਸ਼ਿਤ ਹੋਣ ਤੋਂ ਬਾਅਦ ਤੁਹਾਡੀ ਐਪ ਲਈ ਉਪਲਬਧ ਹੁੰਦੀਆਂ ਹਨ। ਡੌਕਸ ਵਿੱਚ ਕਿਸੇ ਵੀ API ਨੂੰ ਜੋੜਨ ਅਤੇ REST API ਬੈਕਐਂਡ ਬਣਾਉਣ ਲਈ ਰੈਸਿਪੀਆਂ ਹਨ।
ਸਵਾਲ
ਸਰਲ ਸ਼ਬਦਾਂ ਵਿੱਚ API ਕੀ ਹੈ?
API (ਐਪਲੀਕੇਸ਼ਨ ਪ੍ਰੋਗਰਾਮਿੰਗ ਇੰਟਰਫ਼ੇਸ) ਇੱਕ ਤੈਅ ਤਰੀਕਾ ਹੈ ਜਿਸ ਨਾਲ ਇੱਕ ਸੌਫ਼ਟਵੇਅਰ ਦੂਜੇ ਤੋਂ ਡੇਟਾ ਮੰਗਦਾ ਹੈ ਜਾਂ ਕੁਝ ਕਰਵਾਉਂਦਾ ਹੈ। ਤੁਹਾਡੀ ਐਪ ਇੱਕ ਸਹਿਮਤ ਫ਼ਾਰਮੈਟ ਵਿੱਚ ਬੇਨਤੀ ਭੇਜਦੀ ਹੈ, ਅਤੇ ਦੂਜਾ ਸਿਸਟਮ ਜਵਾਬ ਭੇਜਦਾ ਹੈ — ਜਿਵੇਂ ਮੌਸਮ ਦਾ ਡੇਟਾ, ਭੁਗਤਾਨ ਦਾ ਨਤੀਜਾ, ਜਾਂ AI ਦਾ ਬਣਾਇਆ ਜਵਾਬ।
REST API ਕੀ ਹੈ?
REST API ਵੈੱਬ API ਦਾ ਆਮ ਢੰਗ ਹੈ ਜਿੱਥੇ ਹਰ ਕਿਸਮ ਦੀ ਚੀਜ਼ (ਬੁਕਿੰਗਾਂ, ਗਾਹਕ) ਦਾ ਇੱਕ URL ਹੁੰਦਾ ਹੈ, ਅਤੇ ਤੁਸੀਂ ਮਿਆਰੀ HTTP ਤਰੀਕੇ ਵਰਤਦੇ ਹੋ — ਪੜ੍ਹਨ ਲਈ GET, ਬਣਾਉਣ ਲਈ POST, ਅੱਪਡੇਟ ਲਈ PUT ਜਾਂ PATCH, ਹਟਾਉਣ ਲਈ DELETE। ਡੇਟਾ ਆਮ ਤੌਰ 'ਤੇ JSON ਵਿੱਚ ਵਾਪਸ ਆਉਂਦਾ ਹੈ।
API ਕੀ ਹੈ ਅਤੇ ਇਸਨੂੰ ਕਿੱਥੇ ਸੰਭਾਲਣਾ ਚਾਹੀਦਾ ਹੈ?
API ਕੀ ਇੱਕ ਗੁਪਤ ਸਤਰ ਹੈ ਜੋ ਤੁਹਾਡੀ ਐਪ ਨੂੰ ਕਿਸੇ ਸੇਵਾ ਲਈ ਪਛਾਣਦੀ ਹੈ, ਅਤੇ ਅਕਸਰ ਉਸਨੂੰ ਪੈਸੇ ਖ਼ਰਚਣ ਜਾਂ ਡੇਟਾ ਤੱਕ ਪਹੁੰਚਣ ਦਿੰਦੀ ਹੈ। ਇਸਨੂੰ ਸਰਵਰ 'ਤੇ ਇਨਵਾਇਰਨਮੈਂਟ ਵੇਰੀਏਬਲਾਂ ਜਾਂ ਪ੍ਰੋਜੈਕਟ ਸੀਕ੍ਰੇਟਸ ਵਿੱਚ ਰੱਖੋ, ਕਦੇ ਵੀ ਬਰਾਊਜ਼ਰ ਵਿੱਚ ਚੱਲਣ ਵਾਲੇ ਕੋਡ ਜਾਂ ਕਿਸੇ ਜਨਤਕ ਰਿਪੋਜ਼ਟਰੀ ਵਿੱਚ ਨਹੀਂ।
API ਅਤੇ ਵੈੱਬਹੁੱਕ ਵਿੱਚ ਕੀ ਫ਼ਰਕ ਹੈ?
API ਵਿੱਚ ਤੁਹਾਡੀ ਐਪ ਜਦੋਂ ਚਾਹੇ ਕਿਸੇ ਦੂਜੀ ਸੇਵਾ ਤੋਂ ਕੁਝ ਮੰਗਦੀ ਹੈ। ਵੈੱਬਹੁੱਕ ਵਿੱਚ ਕੁਝ ਹੋਣ 'ਤੇ ਦੂਜੀ ਸੇਵਾ ਤੁਹਾਡੀ ਐਪ ਨੂੰ ਕਾਲ ਕਰਦੀ ਹੈ — ਉਦਾਹਰਨ ਲਈ, ਕੋਈ ਭੁਗਤਾਨ ਪ੍ਰਦਾਤਾ ਦੱਸਦਾ ਹੈ ਕਿ ਭੁਗਤਾਨ ਸਫ਼ਲ ਹੋਇਆ।