Ruumiradari API

Esimene versioon on kohalikuks liidestamiseks valmis. Avalik API pole veel aktiveeritud: andmepäringud annavad praegu 503 API_NOT_ACTIVATED. Dokumentatsioon ja skeemid on avalikud.

Andmete lugemine

Püsivad projekti- ja ettevõtte-ID-d võimaldavad ühendada Ruumiradari arendaja veebilehe, CRM-i või portfelliga. V1 ei võimalda andmeid muuta. API ei väljasta kontoandmeid, lemmikuid, autentimiskinnitusi ega pildifaile.

GET /api/v1/meta
GET /api/v1/projects?company_id=endover&limit=25
GET /api/v1/projects/P24
GET /api/v1/companies
GET /api/v1/companies/endover
GET /api/v1/events?project_id=P24

Projektil on ametliku veebilehe aadress, piirkond, etapp, mahu ulatus ja allikad. Detailvastus sisaldab kuupäevadega väiteid. Ettevõtete loend sisaldab organisatsioone; eraisikuid ei nimetata ettevõteteks. Isikud võivad esineda projekti avalike osapooltena.

Lehitsemine ja värskus

Vaikimisi 25, maksimaalselt 50 kirjet. Järgmise lehe annab pagination.next_offset; null tähendab lõppu. Säilita meta.dataset_version ja alusta lehitsemist uuesti, kui versioon muutub. ETag ja If-None-Match võimaldavad muutumata vastuse korral saada 304. checked_on on andmekontrolli kuupäev, sündmuse date selle algallika kuupäev. Automaatne seire pole veel käivitatud.

curl 'http://127.0.0.1:8010/api/v1/projects?company_id=endover&limit=5'
curl 'http://127.0.0.1:8010/api/v1/projects/P24'

Arendaja sisend

Arendaja saab anda JSON-voo oma projektide püsivate external_id väärtuste, veebiaadresside, muudatuste aja ja soovi korral kliendipäevadega. Meie P24-taoline ID seob objekti olemasoleva kirjega. Tundmatu seos vajab kontrollimist; sama nime põhjal automaatset ühendamist ei tehta.

Voo näidise kellaajad on vormingu näited, mitte tuvastatud uued sündmused. Kohalik kontroll valideerib ettevõtte ulatuse, korduvad ID-d, kuupäevade ajavööndi ja HTTPS-aadressid. Tulemus ei muuda portaali ega tõenda esitatud faktide õigsust.

python3 app/scripts/developer_feed.py feed.json --company endover

Ligipääs ja järgmine versioon

V1 töötab kohaliku arendusserveri kaudu ilma API-võtmeta. Avalik aktiveerimine ootab kinnitatud kasutus-/kulupiire ja teenusega ühendatud kulukaitset; keskkonnamuutuja ei saa seda piirangut avada. Vigade koodid on 400 vigane päring, 404 puuduv kirje, 405 keelatud meetod ja 503 aktiveerimata API. CORS-i avalikku erandit ega välistele süsteemidele kirjutamisõigust ei avata.

Kavandatud: kontrollitud ettevõttekonto, ettevõttepõhine võti ja ID-seosed, auditeeritav sisendite vastuvõtt, paranduste ülevaatus ning kulupiiridega sünk või webhook. Need ei kuulu praeguse versiooni töötavasse ulatusse.

Algallikad ja kasutamine

Säilita kirje allikaviited, kontrollkuupäev ja mahu ulatus. Arendaja teatatud ajakava ei ole toimunud sündmus. Fotode õigused ei kandu API-ga üle; pildifailide allalaadimist ega levitusluba API ei anna. Vaata vajadusel projekti algallikat ja selle tingimusi.