17. Samþættingar-API og API-lyklar

Samþættingar-API gerir þínu eigin forriti, töflureikni eða skriptu kleift að lesa verkefnisgögnin þín sjálfvirkt: verkefnalistann, strengjaskrána og efnislistana, rafrásatöflu og tengiklemmulista dreifitaflna, magnskrána og samsetningu teikningapakkans. API-ið les aðeins: það breytir hvorki teikningunni né verkefninu.

Hver getur fengið API-lykil

Rekstraraðili heimilar API-lykil fyrir hvern aðgang. Ef aðgangurinn þinn hefur fengið leyfi birtist spjaldið API-lyklar á síðunni Prófíll; án leyfis sést spjaldið ekki. Aðgangur getur haft í mesta lagi 5 virka lykla í einu.

Lykillinn sér sömu verkefni og þú: þín eigin og, að beiðni, þau sem hafa verið deilt með þér. Listar og magnskrá sameiginlegs verkefnis eru aðeins afhent ef deilingin leyfir einnig útflutning.

Lykill búinn til

Á spjaldinu API-lyklar á síðunni Prófíll smellirðu á hnappinn Nýr lykill.
Gefðu lyklinum nafn (til dæmis nafn forritsins sem mun nota hann).
Veldu gildissvið: Lesa verkefni gefur verkefnalistann og gögn verkefnanna, Lesa skjöl gefur listana, magnskrána og teikningapakkann. Veldu aðeins það sem forritið þarf í raun.
Veldu gildistíma: 30, 90 eða 365 daga. Útrunninn lykill virkar ekki lengur; þú býrð til nýjan í staðinn.
Sláðu inn núverandi lykilorð þitt (fyrir aðgang án lykilorðs þarf nýja innskráningu). Við fyrsta lykil samþykkirðu skilmála um notkun API.

Eftir að lykillinn er búinn til sést hann aðeins í þetta eina skipti: afritaðu hann og geymdu á öruggum stað. Síðar sýnir listinn aðeins forskeyti hans (avk_…), stofn- og lokadagsetningu, síðustu notkun og fjölda kalla. Við sendum einnig tölvupósttilkynningu um nýja lykilinn (án lykilsins sjálfs).

Lykill afturkallaður

Með hnappnum Afturkalla við hlið lykilsins á spjaldinu verður lykillinn ónothæfur strax; ekki er hægt að afturkalla þetta. Afturkallaðu lykilinn þegar þú notar hann ekki lengur, þegar þú leggur niður forritið sem notaði hann eða ef þig grunar að hann hafi lekið.

Öryggisráð

Farðu með lykilinn eins og lykilorðið þitt: sá sem þekkir hann getur lesið verkefnin þín innan tilgreinds gildissviðs.
Geymdu hann í leyndarmálageymslu (lykilorðastjóra, umhverfisbreytu þjónsins eða leynilegri breytu CI), ekki í frumkóða: hann má ekki fara í git-safnið, í sameiginlegan töflureikni eða tölvupóst.
Notaðu hann ekki í kóða sem keyrir í vafra (vefsíða, vafraviðbót): þar getur hver sem er lesið hann. Lykillinn á heima á þjóni, í skriptu eða í skjáborðsforriti.
Gefðu hverju forriti sinn eigin lykil með sem þrengstu gildissviði og stuttum gildistíma; þá stöðvar afturköllun eins lykils ekkert annað.

Notkun úr forriti

Lykillinn er sendur í haus beiðninnar sem Bearer-tákn: Authorization: Bearer avk_…. Endapunktarnir eru undir /api/v1/ (til dæmis GET /api/v1/projects) og svarið er JSON. Nákvæm lýsing á OpenAPI-sniði er á /api/v1/openapi.json; flest þróunartól geta lesið hana inn.

Fjöldi kalla er takmarkaður fyrir hvern lykil og hvern aðgang (sjálfgefið 60 á mínútu og 10.000 á dag); fari kallafjöldinn yfir mörkin svarar þjónninn með 429, bíddu þá aðeins. Innskráning á vefinn (vafrakaka) opnar ekki API-ið og lykill skráir þig ekki inn í vefviðmótið.