ਦਿਨ 0
ਐਕਸੈਸ ਸਾਬਤ ਕਰੋ
ਕੁੰਜੀ (key) ਬਣਾਓ, ਇੱਕ ਪ੍ਰਮਾਣਿਤ ਬੇਨਤੀ ਪੂਰੀ ਕਰੋ, ਅਤੇ ਪਹਿਲੀ ਪ੍ਰਤੀਕਿਰਿਆ ਨੂੰ ਇਸਦੇ ਮੈਟਾਡੇਟਾ ਦੇ ਨਾਲ ਸੇਵ ਕਰੋ।
ਸਟੈਪ ਖੋਲ੍ਹੋ →API ਵਰਕਫਲੋ ਗਾਈਡ
ਤੁਸੀਂ ਕੀ ਬਣਾਉਣਾ ਚਾਹੁੰਦੇ ਹੋ?
ਆਪਣੀ ਨੌਕਰੀ ਦੇ ਸਭ ਤੋਂ ਨੇੜੇ ਦੇ ਨਤੀਜੇ ਦੀ ਚੋਣ ਕਰੋ। ਹਰੇਕ ਰਸਤਾ ਤੁਹਾਨੂੰ ਇੱਕ ਕੰਮ ਕਰਨ ਵਾਲੀ ਬੇਨਤੀ, ਪ੍ਰਤੀਕਿਰਿਆ ਵਿੱਚ ਕੀ ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ, ਇਹ ਕਿਵੇਂ ਜਾਂਚ ਕਰਨਾ ਹੈ ਕਿ ਇਹ ਕੰਮ ਕਰਦਾ ਹੈ, ਅਤੇ ਅਗਲਾ ਲਾਭਦਾਇਕ ਕਦਮ ਦਿੰਦਾ ਹੈ।
ਪੰਜ ਵਿਵਹਾਰਕ ਰਸਤੇ
ਨਤੀਜੇ ਨਾਲ ਸ਼ੁਰੂ ਕਰੋ, ਐਂਡਪੁਆਇੰਟ ਸੂਚੀ ਨਾਲ ਨਹੀਂ।
Selected: Harden a client
ਪਾਥ 1
ਮੈਕਰੋ ਡਾਟਾ ਪ੍ਰਾਪਤ ਕਰੋ
ਇੱਕ ਸਾਫ਼ ਟਾਈਮ ਸੀਰੀਜ਼ ਪ੍ਰਾਪਤ ਕਰੋ ਅਤੇ ਇਸਦੇ ਨਾਲ ਸਰੋਤ ਅਤੇ ਕੁਆਲਿਟੀ ਮੈਟਾਡੇਟਾ ਰੱਖੋ।
ਪਾਥ 2
ਰਿਲੀਜ਼ ਜੌਬਸ ਦੀ ਯੋਜਨਾ ਬਣਾਓ
ਜਾਣੇ ਪਛਾਣੇ ਪ੍ਰਕਾਸ਼ਨ ਸਮਿਆਂ ਦੇ ਆਸ-ਪਾਸ ਟਾਰਗੇਟਡ ਕੰਮ ਚਲਾਉਣ ਲਈ ਰਿਲੀਜ਼ ਕੈਲੰਡਰ ਦੀ ਵਰਤੋਂ ਕਰੋ।
ਪਾਥ 3
ਸਰਪ੍ਰਾਈਜ਼ਾਂ ਨੂੰ ਮਾਪੋ
ਲੁੱਕਅਹੇਡ ਬਾਇਸ (lookahead bias) ਪੈਦਾ ਕੀਤੇ ਬਿਨਾਂ ਪ੍ਰਕਾਸ਼ਿਤ ਮੁੱਲਯਾਂ ਨਾਲ ਪ੍ਰੀ-ਰਿਲੀਜ਼ ਪੂਰਵ ਅਨੁਮਾਨਾਂ ਨੂੰ ਜੋੜੋ।
ਪਾਥ 4
ਲਾਈਵ ਅਪਡੇਟਸ ਪ੍ਰਾਪਤ ਕਰੋ
SSE ਨੂੰ ਇੱਕ ਅਵੈਧਤਾ ਸੰਕੇਤ ਵਜੋਂ ਵਰਤੋ, ਫਿਰ REST ਤੋਂ ਪੂਰਾ ਰਿਕਾਰਡ ਪ੍ਰਾਪਤ ਕਰੋ।
ਪਾਥ 5
ਇੱਕ ਮੈਕਰੋ ਮਾਡਲ ਬਣਾਓ
ਸੰਬੰਧਿਤ ਸੂਚਕਾਂ ਦੇ ਇੱਕ ਛੋਟੇ ਸਮੂਹ ਨੂੰ ਸਰੋਤ-ਲੇਬਲ ਕੀਤੇ ਕਰੰਸੀ ਸਕੋਰਕਾਰਡ ਵਿੱਚ ਬਦਲੋ।
ਤੁਹਾਡਾ 14-ਦਿਨਾਂ ਦਾ API ਟਰਾਇਲ
ਪਹਿਲੀ ਬੇਨਤੀ ਤੋਂ ਇੱਕ ਅਜਿਹੀ ਨੌਕਰੀ ਵੱਲ ਵਧੋ ਜੋ ਰੱਖਣ ਦੇ ਯੋਗ ਹੋਵੇ।
ਟੀਚਾ ਹਰੇਕ ਉਤਪਾਦ ਪੇਜ 'ਤੇ ਜਾਣਾ ਨਹੀਂ ਹੈ। ਇਹ ਉਪਯੋਗੀ ਪ੍ਰਮਾਣਿਤ API ਕੰਮ ਨੂੰ ਪੂਰਾ ਕਰਨਾ, ਕਿਸੇ ਹੋਰ ਦਿਨ ਵਾਪਸ ਆਉਣਾ, ਅਤੇ ਇੱਕ ਦੁਹਰਾਉਣ ਯੋਗ ਡੇਟਾਸੈਟ ਜਾਂ ਐਪਲੀਕੇਸ਼ਨ ਵਰਕਫਲੋ ਨਾਲ ਜਾਣਾ ਹੈ।
ਦਿਨ 1-2
ਰਿਕੁਐਸਟ ਨੂੰ ਭਰੋਸੇਮੰਦ ਬਣਾਓ
ਪ੍ਰਮਾਣਿਕਤਾ ਜਾਂ ਫਿਲਟਰ ਦੀਆਂ ਸਮੱਸਿਆਵਾਂ ਨੂੰ ਹੱਲ ਕਰੋ ਅਤੇ ਪਹਿਲੇ ਸਕ੍ਰਿਪਟ ਨੂੰ ਇੱਕ ਨਾਮਜ਼ਦ ਦੁਹਰਾਉਣ ਯੋਗ ਕੰਮ ਵਿੱਚ ਬਦਲੋ।
ਸਟੈਪ ਖੋਲ੍ਹੋ →ਦਿਨ 3-4
ਰਿਲੀਜ਼ ਟਾਈਮਿੰਗ ਜੋੜੋ
ਕੈਲੰਡਰ ਨੂੰ ਦੂਜੇ ਐਂਡਪੁਆਇੰਟ ਪਰਿਵਾਰ ਵਜੋਂ ਵਰਤੋ ਅਤੇ ਅਗਲੀ ਉਪਯੋਗੀ API ਰਨ ਦਾ ਸ਼ਡਿਊਲ ਬਣਾਓ।
ਸਟੈਪ ਖੋਲ੍ਹੋ →ਦਿਨ 5-7
ਖੋਜ ਆਉਟਪੁੱਟ ਬਣਾਓ
ਉਮੀਦਾਂ ਜਾਂ ਮੈਕਰੋ ਸੀਰੀਜ਼ ਦੇ ਇੱਕ ਛੋਟੇ ਸਮੂਹ ਨੂੰ ਜੋੜੋ, ਫਿਰ ਇੱਕ ਸੇਵ ਕੀਤੀ ਤੁਲਨਾ, ਸਾਰਣੀ, ਜਾਂ ਸਕੋਰਕਾਰਡ ਤਿਆਰ ਕਰੋ।
ਸਟੈਪ ਖੋਲ੍ਹੋ →ਦਿਨ 8-10
ਅਪਡੇਟਸ ਨੂੰ ਆਟੋਮੇਟ ਕਰੋ
ਸ਼ਡਿਊਲਡ REST, SSE, ਜਾਂ ਵੈਬਹੁੱਕਸ ਚੁਣੋ ਅਤੇ ਕਿਸੇ ਹੋਰ ਦਿਨ ਇੱਕ ਹੋਰ ਸਫਲ API ਰਨ ਪੂਰਾ ਕਰੋ।
ਸਟੈਪ ਖੋਲ੍ਹੋ →ਦਿਨ 11-13
ਕਲਾਇੰਟ ਨੂੰ ਮਜ਼ਬੂਤ ਕਰੋ
ਟਾਈਮਆਊਟਸ, ਸੀਮਤ ਰੀਟ੍ਰਾਈਜ਼, ਪ੍ਰਤੀਕਿਰਿਆ ਵੈਲੀਡੇਸ਼ਨ, ਕ੍ਰੇਡੈਂਸ਼ੀਅਲ-ਸੁਰੱਖਿਅਤ ਲੌਗਿੰਗ, ਅਤੇ ਸਟੇਲ-ਡੇਟਾ ਨਿਗਰਾਨੀ ਜੋੜੋ।
ਸਟੈਪ ਖੋਲ੍ਹੋ →ਦਿਨ 14
ਸਬੂਤਾਂ ਦੀ ਸਮੀਖਿਆ ਕਰੋ
ਪੁਸ਼ਟੀ ਕਰੋ ਕਿ API ਇੱਕ ਦੁਹਰਾਇਆ ਜਾ ਸਕਣ ਵਾਲਾ ਕੰਮ ਸਪਲਾਈ ਕਰਦਾ ਹੈ ਜਿਸ ਨੂੰ ਤੁਹਾਡੀ ਟੀਮ ਰੱਖੇਗੀ, ਫਿਰ ਅਗਲਾ ਡੇਟਾਸੈਟ ਜਾਂ ਐਪਲੀਕੇਸ਼ਨ ਵਰਕਫਲੋ ਚੁਣੋ।
ਸਟੈਪ ਖੋਲ੍ਹੋ →Production readiness
ਇੱਕ API ਕਲਾਇੰਟ ਨੂੰ ਪ੍ਰੋਡਕਸ਼ਨ-ਤਿਆਰ ਬਣਾਓ
Production reliability comes from treating status codes differently, keeping retries bounded, reusing ETags, and choosing scheduled REST, SSE, or webhooks for the job.
ਕੰਮ ਕਰਦਾ ਉਦਾਹਰਣ
ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਰੱਖੋ FXMD_API_KEY; ਇਸਨੂੰ ਕਦੇ ਵੀ ਸੋਰਸ ਕੰਟਰੋਲ ਵਿੱਚ ਪੇਸਟ ਨਾ ਕਰੋ।
import os
import requests
from urllib3.util.retry import Retry
session = requests.Session()
retry = Retry(total=3, backoff_factor=0.5, status_forcelist=(429, 502, 503, 504))
session.mount("https://", requests.adapters.HTTPAdapter(max_retries=retry))
response = session.get(
"https://api.fxmacrodata.com/v1/announcements/eur/inflation",
params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
headers={"Accept-Encoding": "gzip"},
timeout=(3.05, 20),
)
response.raise_for_status()ਉਮੀਦ ਕੀਤਾ ਨਤੀਜਾ: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.
ਜਦੋਂ ਪਹਿਲਾ ਸਕ੍ਰਿਪਟ ਇੱਕ ਅਸਲੀ ਸਿਸਟਮ ਬਣ ਜਾਂਦਾ ਹੈ
ਟਰਬਲਸ਼ੂਟਿੰਗ ਅਤੇ ਪ੍ਰੋਡਕਸ਼ਨ ਮਾਰਗਦਰਸ਼ਨ
ਇਨ੍ਹਾਂ ਗਾਈਡਾਂ ਦੀ ਵਰਤੋਂ ਕਰੋ ਜਦੋਂ ਕੋਈ ਜਵਾਬ ਫੇਲ ਹੋ ਜਾਂਦਾ ਹੈ, ਕੋਈ ਡੇਟਾ ਨਹੀਂ ਮਿਲਦਾ, ਜਾਂ ਕੈਸ਼ਿੰਗ, ਟਾਈਮਆਊਟਸ, ਰੀਟ੍ਰਾਈਜ਼, ਅਤੇ ਇਵੈਂਟ ਡਿਲੀਵਰੀ ਵਰਗੇ ਪ੍ਰੋਡਕਸ਼ਨ ਕੰਟਰੋਲ ਦੀ ਲੋੜ ਹੁੰਦੀ ਹੈ।
| ਗਾਈਡ | ਇਸਦੀ ਵਰਤੋਂ ਉਦੋਂ ਕਰੋ ਜਦੋਂ | ਸ਼ੁਰੂ ਕਰੋ |
|---|---|---|
| ਫੇਲ ਜਾਂ ਖਾਲੀ ਰਿਸਪਾਂਸ ਦਾ ਨਿਦਾਨ ਕਰੋ | ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਜ਼ਾਹਰ ਕੀਤੇ ਬਿਨਾਂ ਪ੍ਰਮਾਣਿਕਤਾ, ਐਕਸੈਸ, ਪਾਥ, ਰੇਟ-ਲਿਮਿਟ, ਅਤੇ ਡੇਟਾ-ਉਪਲਬਧਤਾ ਦੀਆਂ ਸਮੱਸਿਆਵਾਂ ਨੂੰ ਵੱਖ ਕਰੋ। | ਗਾਈਡ ਖੋਲ੍ਹੋ → |
| ਇੱਕ API ਕਲਾਇੰਟ ਨੂੰ ਪ੍ਰੋਡਕਸ਼ਨ-ਤਿਆਰ ਬਣਾਓ | ਟਾਈਮਆਊਟਸ, ਸੀਮਤ ਰੀਟ੍ਰਾਈਜ਼, ਕੈਸ਼ਿੰਗ, ਕੰਡੀਸ਼ਨਲ ਰਿਕੁਐਸਟਸ, ਅਤੇ ਸਹੀ ਡਿਲੀਵਰੀ ਪੈਟਰਨ ਜੋੜੋ। | ਗਾਈਡ ਖੋਲ੍ਹੋ → |