API વર્કફ્લો ગાઇડ

તમે શું બનાવવા માંગો છો?

તમારી નોકરીની સૌથી નજીકનું પરિણામ પસંદ કરો. દરેક પાથ તમને એક કાર્યરત વિનંતી, પ્રતિસાદમાં શું હોવું જોઈએ, તે કામ કરે છે કે નહીં તે કેવી રીતે તપાસવું અને આગામી ઉપયોગી પગલું આપે છે.

પાંચ વ્યવહારુ માર્ગો

પરિણામથી શરૂઆત કરો, એન્ડપોઇન્ટ લિસ્ટથી નહીં.

Selected: Harden a client

તમારી 14-દિવસની API ટ્રાયલ

પ્રથમ વિનંતીથી રાખવા યોગ્ય કામ તરફ આગળ વધો.

લક્ષ્ય દરેક પ્રોડક્ટ પેજની મુલાકાત લેવાનો નથી. તે ઉપયોગી ઓથેન્ટિકેટેડ API કાર્ય પૂર્ણ કરવાનો, બીજા દિવસે પરત આવવાનો અને પુનરાવર્તિત ડેટાસેટ અથવા એપ્લિકેશન વર્કફ્લો સાથે છોડવાનો છે.

API પ્રગતિ તપાસો

દિવસ 0

એક્સેસ સાબિત કરો

કી (key) બનાવો, એક પ્રમાણિત વિનંતી પૂર્ણ કરો, અને તેના મેટાડેટા સાથે પ્રથમ પ્રતિસાદ સાચવો.

સ્ટેપ ખોલો →

દિવસો 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.

25 minutes Production pattern જાહેરાતોchangesstreamwebhooks

કાર્યરત ઉદાહરણ

તમારી કી અહીં રાખો 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.

જ્યારે પ્રથમ સ્ક્રિપ્ટ વાસ્તવિક સિસ્ટમ બને છે

ટ્રબલશૂટિંગ અને પ્રોડક્શન માર્ગદર્શન

જ્યારે પ્રતિસાદ નિષ્ફળ જાય, કોઈ ડેટા પરત ન કરે, અથવા કેશિંગ, ટાઇમઆઉટ, રીટ્રાય અને ઇવેન્ટ ડિલિવરી જેવા પ્રોડક્શન કંટ્રોલ્સની જરૂર હોય ત્યારે આ માર્ગદર્શિકાઓનો ઉપયોગ કરો.

માર્ગદર્શિકાતેનો ઉપયોગ કરો જ્યારેStart
નિષ્ફળ અથવા ખાલી રિસ્પોન્સનું નિદાન કરો તમારી કી જાહેર કર્યા વિના ઓથેન્ટિકેશન, એક્સેસ, પાથ, રેટ-લિમિટ અને ડેટા-અવેલેબિલિટી સમસ્યાઓને અલગ કરો. માર્ગદર્શિકા ખોલો →
API ક્લાયન્ટને પ્રોડક્શન-રેડી બનાવો ટાઈમઆઉટ્સ, બાઉન્ડેડ રીટ્રાયઝ, કેશિંગ, કન્ડિશનલ રિક્વેસ્ટ્સ અને યોગ્ય ડિલિવરી પેટર્ન ઉમેરો. માર્ગદર્શિકા ખોલો →