API სამუშაო პროცესის სახელმძღვანელო

რა გსურთ ააშენოთ?

შეარჩიეთ თქვენს სამუშაოსთან ყველაზე ახლოს მყოფი შედეგი. თითოეული გზა გაძლევთ ერთ სამუშაო მოთხოვნას, იმას თუ რას უნდა შეიცავდეს პასუხი, როგორ შეამოწმოთ მისი მუშაობა და შემდეგ სასარგებლო ნაბიჯს.

ხუთი პრაქტიკული გზა

დაიწყეთ შედეგით და არა endpoint-ების სიით.

არჩეული: მოიტანეთ მაკრო მონაცემები

გზა 1 მაკრო მონაცემების წამოღება მიიღეთ სუფთა დროითი სერია და შეინარჩუნეთ წყაროსა და ხარისხის მეტამონაცემები მის გვერდით. გზა 2 დაგეგმეთ გამოქვეყნების სამუშაოები გამოიყენეთ გამოშვების კალენდარი ცნობილი გამოქვეყნების დროებთან დაკავშირებული მიზნობრივი სამუშაოების შესასრულებლად. გზა 3 გაზომეთ სიურპრიზები შეაერთეთ წინასწარი გამოშვების პროგნოზები გამოქვეყნებულ მნიშვნელობას წინასწარი ცოდნის მიკერძღვის (lookahead bias) გარეშე. გზა 4 მიიღეთ live განახლებები გამოიყენეთ SSE როგორც ვალიდაციის ბათილად გამოცხადების სიგნალი, შემდეგ კი მოითხოვეთ სრული ჩანაწერი REST-დან. გზა 5 აშენეთ მაკრო მოდელი გადააქციეთ დაკავშირებული ინდიკატორების მცირე ჯგუფი წყაროს მიერ მარკირებულ ვალუტის სქორკარდად.

თქვენი 14-დღიანი API სატესტო პერიოდი

გადადით პირველი მოთხოვნიდან იმ სამუშაოზე, რომელიც ღირს შენახვის.

მიზანი არ არის ყველა პროდუქტის გვერდზე სტუმრობა. მიზანია სასარგებლო ავთენტიფიცირებული API სამუშაოს შესრულება, სხვა დღეს დაბრუნება და წასვლა განმეორებადი მონაცემთა ნაკრებით ან აპლიკაციის სამუშაო პროცესით.

შეამოწმეთ API პროგრესი

დღე 0

დაადასტურეთ წვდომა

შექმენით გასაღები, შეასრულეთ ერთი ავთენტიფიცირებული მოთხოვნა და შეინახეთ პირველი პასუხი მისი მეტამონაცემებით.

გახსენით ნაბიჯი →

დღეები 1-2

გახადეთ მოთხოვნა საიმედო

მოაგვარეთ ავთენტიფიკაციის ან ფილტრაციის პრობლემები და გადააქციეთ პირველი სკრიპტი დასახელებულ, განმეორებად დავალებად.

გახსენით ნაბიჯი →

დღეები 3-4

დაამატეთ გამოშვების დრო

გამოიყენეთ კალენდარი, როგორც მეორე endpoint-ების ოჯახი და დაგეგმეთ შემდეგი სასარგებლო API გაშვება.

გახსენით ნაბიჯი →

დღეები 5-7

შექმენით კვლევის შედეგი

დაამატეთ მოლოდინები ან მაკრო სერიების მცირე ჯგუფი, შემდეგ შექმენით ერთი შენახული შედარება, ცხრილი ან სქორქარდი.

გახსენით ნაბიჯი →

დღეები 8-10

განახლებების ავტომატიზაცია

შეარჩიეთ დაგეგმილი REST, SSE, ან webhooks და დაასრულეთ კიდევ ერთი წარმატებული API გაშვება სხვა დღეს.

გახსენით ნაბიჯი →

დღეები 11-13

გაამაგრეთ კლიენტი

დაამატეთ თაიმაუტები, შეზღუდული თავდახელებები (retries), პასუხის ვალიდაცია, მონაცემთა უსაფრთხოな ლოგირება და მოძველებული მონაცემების მონიტორინგი.

გახსენით ნაბიჯი →

დღე 14

გადახედეთ მტკიცებულებებს

დაადასტურეთ, რომ API უზრუნველყოფს განმეორებად სამუშაოს, რომელსაც თქვენი გუნდი გააგრძელებს, შემდეგ კი აირჩიეთ შემდეგი მონაცემთა ნაკრები ან აპლიკაციის სამუშაო პროცესი.

გახსენით ნაბიჯი →

პირველი მოთხოვნა

მაკრო ისტორიის წამოღება და შენახვა

დაიწყეთ ერთი ვალუტით და ინდიკატორით, რომელიც უკვე გესმით. ეს ამარტივებს ავთენტიფიკაციის, პასუხის ფორმის, პაგინაციის და შენახვის შემოწმებას მანამ, სანამ მეტ სერიას დაამატებთ.

10 წუთი დაიწყეთ აქ განცხადებები

სამუშაო მაგალითი

შეინახეთ თქვენი გასაღები FXMD_API_KEY; არასოდეს ჩასვათ იგი წყაროს კონტროლში (source control).

import os
import requests

response = requests.get(
    "https://api.fxmacrodata.com/v1/announcements/eur/inflation",
    params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
    timeout=20,
)
response.raise_for_status()
payload = response.json()
print(payload["data"][0])

მოსალოდნელი შედეგი: 200 პასუხი ბოლო EUR ინფლაციის დაკვირვებებით, პლუს პასუხის მეტამონაცემები, რომლებიც აღწერს მწკრივს, წყაროს, გვერდგადასხვას და მონაცემთა ხარისხს.

როდესაც პირველი სკრიპტი ხდება რეალური სისტემა

პრობლემების მოგვარება და production სახელმძღვანელო

გამოიყენეთ ეს სახელმძღვანელოები, როდესაც პასუხი ვერ მიიღება, არ აბრუნებს მონაცემებს ან საჭიროებს პროდუქციულ კონტროლს, როგორიცაა ქეშირება, თაუტიმები, ხელახალი მცდელობები და მოვლენების მიწოდება.

გზამკვლევიგამოიყენეთ მაშინ, როცადაწყება
წარუმატებელი ან ცარიელი პასუხის დიაგნოსტიკა ავთენტიფიკაციის, წვდომის, გზის, rate-limit-ისა და მონაცემთა ხელმისაწვდომობის ცალკეული პრობლემების გარკვევა თქვენი გასაღების გამჟღავნების გარეშე. გახსენით გზამკვლევი →
გახადეთ API კლიენტი საწარმოო მზადყოფნისთვის დაამატეთ ტაიმაუტები, შეზღუდული თავეupები, ქეშირება, პირობითი მოთხოვნები და სწორი მიწოდების მოდელი. გახსენით გზამკვლევი →