API referansı

Bu bölüm her derlemede api/openapi.json dosyasından üretilir; elle yazılmış kopya yoktur. Uç ve alan açıklamaları OpenAPI dosyasındaki gibi İngilizcedir. Kimlik, oran sınırı ve hata biçimi için ilgili kılavuz sayfalarına bakın.

Kaynak: api/openapi.json, API sürümü 0.1.0, sha256 edae20545f20.

Herkese açık uçların OpenAPI dosyası (istemci üreticileri için)

Durum

Servisin ayakta olup olmadığı.

• GET /v1/health Health

Uçuş yükleme

IGC yükleme (sunucudan sunucuya; rıza sürümüyle).

• POST /v1/flights Upload a flight track (IGC, GPX or FIT)

Kalkış ve iniş

Onaylı kalkış ve iniş noktaları, GeoJSON.

• GET /v1/sites Approved takeoff and landing sites in a bounding box
• GET /v1/sites/{site_id}/suitability Take-off suitability for a day from the wind forecast (pre-flight planning only)

Katman parametreleri

Yamaç katmanları için saatlik güneş konumu ve tahmini rüzgâr (yalnız uçuş öncesi).

• GET /v1/slope-conditions Sun position and forecast wind per hour for the slope layers (pre-flight only)

Rota önerisi

Bir kalkıştan yerel gün ve saat için birkaç sıralanmamış rota seçeneği, iniş alternatifleriyle; yalnız uçuş öncesi planlama, her zaman sabit uçuş öncesi uyarısıyla gösterilir.

• GET /v1/routes Route suggestions from a take-off for a day and hour (pre-flight planning only)

Bölge paketleri

İnternetsiz kullanım için bölge başına PMTiles dosyaları.

• GET /v1/packs/{region} Current offline pack of a region, with download URLs
• GET /v1/packs/{region}/{pack_version}/{file} Download one pack file through a signed URL (no API key)

Açık veri

Yıllık açık veri paketleri (CC BY 4.0): sürümler, dosyalar, boyut ve SHA-256; aynı paket Atlas'ta anahtarsız indirilir.

• GET /v1/open-data Published yearly open data packages (CC BY 4.0)
• GET /v1/open-data/{year}/{file} Download one file of a yearly open data package

Bölgeler

Uçuş bölgeleri ve bölge profilleri.

• GET /v1/regions Public flying regions with simplified boundaries
• GET /v1/regions/{region}/profile Profile of a public flying region
• GET /v1/regions/{region}/incidents Known incidents and precautions of a public flying region

Rıza

Katkı rızasının geri çekilmesi ve yeniden verilmesi.

• POST /v1/consents/withdrawals Withdraw a pilot's consent to the shared layers
• POST /v1/consents/grants Give consent to the shared layers again

Paylaşım

Uçuşun herkese açık tekrar bağlantısını açma ve kapatma.

• POST /v1/flights/{flight_id}/shares Share a flight: open (or return) its public replay link
• DELETE /v1/flights/{flight_id}/shares Stop sharing a flight: its public link is gone at once

KVKK silme

Pilotun silme talebinin Kunduzo üzerinden bildirilmesi; uçuş verisi silinir, mezar taşı kalır.

• POST /v1/deletions Delete a pilot's flights, or the pilot's data altogether (KVKK)
• GET /v1/deletions/{deletion_id} Progress of a deletion request

Gizlilik maskeleri

Pilotun kendi uygulamasının kurduğu ev ve özel maskeler: içlerindeki fix'ler bütün paylaşılan katmanlardan çıkar.

• GET /v1/privacy-masks The privacy masks of a pilot
• POST /v1/privacy-masks Add a home or custom privacy mask for a pilot
• DELETE /v1/privacy-masks/{mask_id} Remove a privacy mask of a pilot

Tekrar

Paylaşılmış uçuşun herkese açık tekrar verisi.

• GET /v1/replay/{public_id} Public replay of a shared flight
• POST /v1/replay/{public_id}/video Ask for the MP4 video of a shared flight
• GET /v1/replay/{public_id}/video/{video_format} State of a video, with a download URL when ready
• GET /v1/replay/{public_id}/video/{video_format}/file Download a video through a signed URL (no API key)

Şemalar · Hata kodları

• Şemalar
• Hata kodları