Astronaut API — შესავალი
Base URL, ავტორიზაცია, ლიმიტები და პასუხის ფორმატი.
მხარდაჭერილად ითვლება მხოლოდ მიმდინარე build-ის გამოქვეყნებულ OpenAPI schema-ში არსებული /api/v1/ ინტერფეისი. Dashboard-ის შიდა URL-ები საჯარო API არ არის.
Contract-first
endpoint, method, request/response ველები, permission და rate limit ზუსტად OpenAPI აღწერიდან აიღე; დოკუმენტაციაში არარსებული endpoint არ გამოიცნო.
ავტორიზაცია
გამოიყენე მინიმალური scope-ის token და HTTPS. token URL-ში, browser code-ში ან Git-ში არ ჩაწერო.
Write უსაფრთხოება
თუ schema ითხოვს, გამოიყენე idempotency key და შეინახე correlation ID; timeout-ის შემდეგ final resource state გადაამოწმე.
შეცდომები
დაამუშავე schema-ში აღწერილი status code და response ფორმატი. მომხმარებელს უსაფრთხო ტექსტი აჩვენე, სრული დეტალი კი correlation ID-ით log-ში დატოვე.