ამ ეტაპზე API გამოიყენება Folding Monitor-ის მიერ შიდა მიზნებისთვის, რათა უზრუნველყოს ლიდერბორდები, პროფილის გვერდები, გუნდის გვერდები, ქვეყნების რეიტინგები, ძიება, გენერირებული ხელმოწერის ბარათები და სერვისის სხვა ფუნქციები.
საჯარო API ჯერ ხელმისაწვდომი არ არის, თუმცა ის გრძელვადიანი პროდუქტის მიმართულების ნაწილია.
ჩვენ მას ვიყენებთ შიდა მიზნებისთვის, რათა სერვისი იმუშაოს და საჯარო ინტერფეისი იყოს სწრაფი, თანმიმდევრული და საიმედო.
შიდა API გვეხმარება შემდეგ მონაცემებთან მუშაობაში:
Folding@home-ის მომხმარებლის ID-ები, სახელები, კრედიტები, სამუშაო ერთეულები, რანგები, გუნდები, ქვეყნები და აქტივობის შეჯამებები.
გუნდის ID-ები, გუნდის სახელები, ლოგოები, წევრები, კრედიტები, სამუშაო ერთეულები, რანგის ცვლილება და ლიდერბორდის პოზიციები.
ქვეყნებზე დაფუძნებული რეიტინგები, წარმოდგენილი ქვეყნები, აქტივობის შეჯამებები და მომხმარებლები ქვეყნის პარამეტრების გარეშე.
24 სთ, 7 დღე, 30 დღე და ყველა დროის რეიტინგები მომხმარებლებისთვის, გუნდებისთვის და ქვეყნებისთვის.
ფორუმის ხელმოწერის ბარათები, პროფილის წინასწარი ხედები და სხვა ვიზუალური ელემენტები Folding@home-ის კონტრიბუციის მონაცემებზე დაყრდნობით.
ჩვენ გვინდა, რომ საჯარო API იყოს სასარგებლო, სტაბილური და პასუხისმგებლობით შექმნილი.
API-ის ძალიან ადრე გახსნამ შეიძლება პრობლემები შექმნას: არასტაბილური endpoints, გაურკვეველი ლიმიტები, არათანმიმდევრული მონაცემთა ფორმატები, ზედმეტი სერვერის დატვირთვა და breaking changes ადრეული მომხმარებლებისთვის.
საჯარო endpoints-ის ხელმისაწვდომობამდე გვინდა სათანადოდ განვსაზღვროთ მნიშვნელოვანი ნაწილები:
მკაფიო response ფორმატები მომხმარებლებისთვის, გუნდებისთვის, ქვეყნებისთვის, რეიტინგებისთვის და დროის პერიოდებისთვის.
გონივრული ლიმიტები, რომლებიც იცავს სერვისს და ამავე დროს API-ს სასარგებლოს ხდის.
გამჭვირვალე მოლოდინები განახლების სიხშირის, დაყოვნებების და ისტორიული მონაცემების შესახებ.
მკაფიო მითითებები, როგორ უნდა მიეთითოს Folding Monitor-ის მონაცემები გარე გამოყენებისას.
Endpoints, რომლებიც საკმარისად საიმედოა დეველოპერებისთვის, საზოგადოებრივი ინსტრუმენტებისთვის, დაფებისთვის და ფორუმის ინტეგრაციებისთვის.
ფრთხილი გამიჯვნა საჯარო სტატისტიკას, დაკავშირებული ანგარიშების მონაცემებს, შიდა სერვისის მონაცემებს და დაცულ ტექნიკურ ინფორმაციას შორის.
მომავალ საჯარო API-ს შეიძლება ჰქონდეს endpoints შემდეგისთვის:
Folding@home-ის მომხმარებლის პროფილების და კონტრიბუციის შეჯამებების ძიება ან მიღება.
გუნდის პროფილების, წევრების რაოდენობის, ლოგოების, რანგის მონაცემების და აქტივობის შეჯამებების მიღება.
ქვეყნებზე დაფუძნებულ სტატისტიკასა და რეიტინგებზე წვდომა არჩეულ დროის პერიოდებში.
ტოპ მომხმარებლების, გუნდებისა და ქვეყნების მიღება 24 სთ, 7 დღე, 30 დღე და ყველა დროის პერიოდებისთვის.
მომხმარებლისა და გუნდის ხელმოწერის ბარათების რესურსების გენერაცია ან მიღება ფორუმებისა და საზოგადოებრივი გვერდებისთვის.
ლიდერბორდის ცვლილებების, წინ მიმავალი მომხმარებლების, აქტიური გუნდების და ქვეყნების მონაწილეობის ტენდენციების თვალყურის დევნება.
ჩასაშენებელი ვიჯეტების მხარდაჭერა გუნდებისთვის, მომხმარებლებისთვის, ფორუმებისთვის და საზოგადოებრივი ვებსაიტებისთვის.
თუ საჯარო API დაინერგება, ის პასუხისმგებლიანი გამოყენებისთვის იქნება შექმნილი.
მიზანი არ არის შეუზღუდავი scraping-ის ან დიდი მოცულობის მონაცემთა ამოღების შექმნა. მიზანია სასარგებლო საზოგადოებრივი ინსტრუმენტების, დაფების, ფორუმის ინტეგრაციების, გუნდის ვებსაიტებისა და კვლევისთვის შესაფერისი ვიზუალიზაციების მხარდაჭერა სერვისის სტაბილურობის დაზიანების გარეშე.
მომავალი API შეიძლება მოიცავდეს:
• API გასაღებებს;
• rate limits;
• endpoint-სპეციფიკურ კვოტებს;
• ქეშირების მოთხოვნებს;
• ატრიბუციის წესებს;
• ბოროტად გამოყენების პრევენციას;
• ვერსირებულ endpoints-ს;
• დეველოპერის დოკუმენტაციას.
საჯარო API-ზე რეგისტრაციებს ჯერ არ ვიღებთ.
თუმცა ჩვენთვის საინტერესოა, რა იქნებოდა სასარგებლო დეველოპერებისთვის, გუნდის მენეჯერებისთვის, საზოგადოების წევრებისთვის და Folding@home-ის კონტრიბუტორებისთვის.
შეგიძლიათ გამოგვიგზავნოთ API-ის იდეები, endpoint მოთხოვნები, ინტეგრაციის საჭიროებები ან ადრეული წვდომის ინტერესი შემდეგ მისამართზე:
general@vitaltale.com
სასარგებლო უკუკავშირი შეიძლება მოიცავდეს:
• რომელ მონაცემებზე გსურთ წვდომა;
• რა ტიპის პროექტის ან ინტეგრაციის შექმნა გსურთ;
• გჭირდებათ თუ არა მომხმარებლის, გუნდის, ქვეყნის ან ლიდერბორდის მონაცემები;
• მოსალოდნელი მოთხოვნების მოცულობა;
• სასურველი მონაცემთა ფორმატები;
• გჭირდებათ თუ არა ვიჯეტები, სურათები, JSON endpoints ან ისტორიული სტატისტიკა.
საჯარო API: ჯერ ხელმისაწვდომი არ არის
შიდა API: აქტიურია
დეველოპერის დოკუმენტაცია: დაგეგმილია
ადრეული წვდომა: ჯერ არ არის გახსნილი
უკუკავშირი: მივესალმებით მისამართზე general@vitaltale.com
Folding Monitor იქმნება API-მზადყოფნის გათვალისწინებით, მიუხედავად იმისა, რომ საჯარო ინტერფეისი კვლავ მთავარ პრიორიტეტად რჩება.