Määritä Canvan järjestelmänvalvojan sovellusliittymä ja käytä sitä
Huomautus: Tarvitset Canva-organisaation, jotta voit käyttää Admin API:ta. Pääkäyttäjän API toimii organisaatiotasolla.
Canva Admin API -rajapinnan avulla voit automatisoida organisaation hallintaa omista järjestelmistäsi käsin. Hallitse käyttäjiä, tiimejä, ryhmiä ja jäsenyyksiä sekä hae tarkastuslokin tapahtumia ilman, että sinun tarvitsee tehdä näitä tehtäviä manuaalisesti Canvassa.
Tarkista saatavuus
- Saatavilla Canva suuryrityksille-, Canva Districts- ja Canva kampuksille -paketeissa.
- Käyttöoikeus on organisaation pääkäyttäjillä.
- Saatavilla yhden tai usean tiimin organisaatioille.
Tarkista vaatimukset
Varmista ennen Admin API -rajapinnan käyttöönottoa, että organisaatiosi täyttää seuraavat vaatimukset:
- Organisaatiotaso: Admin API on organisaatiokohtainen. Se on saatavilla yhden tai usean tiimin organisaatioille Canva suuryrityksille-, Canva Districts- ja Canva Campus -paketeissa.
- Organisaation pääkäyttäjän tili: Vain organisaation pääkäyttäjät voivat luoda ja hallita Admin API -asiakkaita Canvan asetuksissa.
- Sisäinen tai ulkoistettu ohjelmistokehitys: Organisaatiollasi on oltava kehitysresursseja integraation rakentamiseen ja ylläpitoon. Canva ei tarjoa käyttöönottoon liittyvää tukea.
- Jos tiimisi ei pysty rakentamaan API-rajapintaan perustuvaa ratkaisua, SCIM-hallinta sopii paremmin käyttäjähallinnan automatisointiin organisaatiossasi.
- Canva-rakenteen tuntemus: Varmista ennen integraation rakentamista, että tunnet hyvin organisaatiosi, tiimiesi ja ryhmiesi rakenteen Canvassa.
- Monivaiheinen tunnistautuminen (MFA) tai kertakirjautumisella (SSO) hallinnoitu tili: Admin API -rajapinnan määrittävällä organisaation pääkäyttäjällä on oltava joko MFA käytössä tai SSO-hallinnoitu tili. Organisaation, jota pääkäyttäjä edustaa, on hallinnoitava tiliä tai omistettava se.
Selvitä, mitä voit hallita
Admin API tarjoaa seuraavat päätepisteet:
- Käyttäjät, tiimit ja ryhmät: luonti, tarkastelu, päivitys ja poistaminen.
- Jäsenyydet: henkilöiden lisääminen tiimeihin ja ryhmiin tai poistaminen niistä sekä heidän rooliensa määrittäminen.
- Tarkastuslokit: tarkastuslokin tapahtumien hakeminen ajastetusti.
- Tiimikutsut: henkilöiden kutsuminen tiimiin (myös organisaation ulkopuolelta), odottavien kutsujen tarkastelu, aiemman kutsulinkin hakeminen täsmällisen sähköpostiosoitteen perusteella sekä kutsujen peruuttaminen.
Ota Admin API käyttöön
Organisaation pääkäyttäjä luo Admin API -asiakkaan ja käyttää sitä API-kutsujen tekemiseen.
Määritä pääkäyttäjän API
- Siirry kohtaan Asetukset.
- Valitse Pääkäyttäjä-API ja valitse sitten Luo API-asiakasohjelma.
- Nimeä asiakasohjelma ja valitse laajuudet, jotka määrittävät, mihin asiakasohjelma voi päästä käsiksi.
- Valitse Jatka.
- Kopioi asiakasohjelman tunnus ja asiakasohjelman salaisuus ja valitse sitten Valmis.
- Vaihda tunnukset käyttövaltuustunnisteeseen, joka on voimassa neljä tuntia.
- Käytä käyttövaltuustunnistetta kutsuaksesi pääkäyttäjä-APIa.
Vaihtaaksesi asiakkaan tunnistetiedot käyttöoikeustunnisteeksi ja aloittaaksesi API-pyyntöjen tekemisen, tutustu Canva Admin API -dokumentaatioon.
Jos haluat teknisiä lisätietoja API-pyyntöjen todentamisesta ja OAuth 2.0 -käyttöoikeustunnisteiden käytöstä, jaa Canva Admin API -todennuksen dokumentaatio kehitystiimillesi.
Admin API -tarkastuslokit
Admin API:n kautta tehdyt toiminnot kirjataan Admin API -asiakkaan nimiin, eivätkä niitä tehneen yksittäisen pääkäyttäjän nimiin.
Tarkastuslokien Actor-kentässä näkyvät Admin API -asiakkaan nimi ja asiakastunnus. Näin voit tunnistaa, mikä integraatio suoritti toiminnon.
Voit myös selvittää, kuka organisaation pääkäyttäjä loi, päivitti tai poisti tietyn API-asiakkaan.
Lisätietoja on ohjeessa Tietoja Canvan tarkastuslokeista.
Kutsu henkilöitä tiimeihin
Organisaation pääkäyttäjät voivat kutsua Admin API:n avulla henkilöitä tiimiin, myös organisaation ulkopuolisia yhteistyökumppaneita.
Huomioitavaa
- Jokainen luomasi kutsu koskee yhtä tiimiä ja yhtä sähköpostiosoitetta.
- Kutsua voi käyttää kerran, ja se vanhenee 30 päivän kuluttua.
- Asetuksistasi riippuen Canva ei välttämättä lähetä kutsua automaattisesti sähköpostitse. Jaa tarvittaessa kutsulinkki suoraan kutsuttavalle.
- Pidä kutsulinkit yksityisinä. Kutsulinkki toimii vain siinä sähköpostiosoitteessa, jota varten se luotiin.
- Tiimisi nykyiset kutsu- ja verkkotunnusasetukset koskevat myös kutsumiasi henkilöitä.
- Jos kutsuttavalle on jo odottava kutsu, uuden kutsun luominen palauttaa saman kutsutietueen. Tällöin voimassaoloaika alkaa uudelleen pyynnön ajankohdasta ja on 30 päivää, ja kutsun rooli päivitetään pyydetyksi rooliksi.
Päätepisteiden tiedot ovat Canva Admin API -dokumentaatiossa.
Valitse Admin API tai SCIM
Sekä Admin API että SCIM soveltuvat käyttäjien hallintaan.
Admin API:n avulla voit hallita Canva-organisaatiota käyttäjähallintaa laajemmin. Se kattaa tiimit, ryhmät, jäsenyydet ja tarkastuslokit.
SCIM soveltuu vakiomuotoiseen käyttäjätilien hallintaan ja käytöstä poistamiseen. Jos tarvitset vain vakiomuotoista käyttäjätilien hallintaa tai tiimisi ei pysty rakentamaan mukautettua API-integraatiota, SCIM sopii tarpeisiisi paremmin.
Usein kysytyt kysymykset
Tarvitseeko organisaationi kehittäjän Admin API:n käyttöön?
Kyllä. Admin API:n käyttö edellyttää, että organisaatiollasi on sisäisiä tai ulkoistettuja kehitysresursseja integraation rakentamiseen ja ylläpitoon. Canva ei tarjoa käyttöönottoon liittyvää tukea. Jos tiimisi ei pysty rakentamaan API-rajapintaan perustuvaa ratkaisua, SCIM-hallinta sopii paremmin käyttäjähallinnan automatisointiin organisaatiossasi.
Tarvitseeko kaikkien organisaationi jäsenten käyttää MFA:ta tai SSO:ta Admin API:n käyttöön?
Ei. Admin API -rajapinnan määrittävällä organisaation pääkäyttäjällä on oltava joko MFA käytössä tai SSO-hallinnoitu tili. Organisaation, jota pääkäyttäjä edustaa, on hallinnoitava tiliä tai omistettava se. Muut organisaation jäsenet eivät tarvitse MFA:ta tai SSO:ta Admin API:n käyttöä varten.
Voiko organisaationi kutsua ulkoisia yhteistyökumppaneita Admin API:n avulla?
Kyllä. Organisaation pääkäyttäjät voivat kutsua Admin API:n avulla henkilöitä tiimeihin, myös ulkoisia yhteistyökumppaneita. Tiimisi nykyiset kutsu- ja verkkotunnusasetukset koskevat myös kutsumiasi henkilöitä.
Voimmeko hakea aiemman kutsulinkin uudelleen luomatta uutta kutsua?
Kyllä. Voit hakea aiemman kutsulinkin kutsuttavan täsmällisen sähköpostiosoitteen avulla luomatta uutta kutsua.
Oliko tästä apua?
Hyödyllinen
Ei hyödyllistä