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:n avulla voit automatisoida organisaation hallintaa omista järjestelmistäsi käsin. Hallitse käyttäjiä, tiimejä, ryhmiä ja jäsenyyksiä sekä hae tarkastuslokitapahtumia 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 ja usean tiimin organisaatioille.
Tarkista vaatimukset
Varmista ennen Admin API:n käyttöönottoa, että organisaatiosi täyttää seuraavat vaatimukset:
- Organisaatiotaso: Admin API toimii organisaatiokohtaisesti. Se on saatavilla yhden ja usean tiimin organisaatioille Canva suuryrityksille-, Canva Districts- ja Canva kampuksille -paketeissa.
- Organisaation pääkäyttäjän tili: Vain organisaation pääkäyttäjät voivat luoda ja hallita Admin API -asiakkaita Canvan asetuksissa.
- Oma tai ulkoistettu kehitystiimi: Organisaatiosi tarvitsee kehitysresursseja integraation rakentamiseen ja ylläpitoon. Canva ei tarjoa käyttöönoton tukea.
- Jos tiimisi ei pysty rakentamaan API-integraatiota, SCIM-hallinta sopii paremmin käyttäjähallinnan automatisointiin organisaatiossasi.
- Canva-rakenteen tuntemus: Varmista, että ymmärrät selkeästi, miten organisaatiosi, tiimisi ja ryhmäsi on määritetty Canvassa, ennen kuin rakennat integraation.
- Monivaiheinen tunnistautuminen (MFA) tai kertakirjautumisen hallinnoima tili: Admin API:n määrittävällä organisaation pääkäyttäjällä on oltava joko MFA käytössä tai kertakirjautumisen hallinnoima tili. Tilin on oltava sen organisaation hallinnoima tai omistama, jonka puolesta pääkäyttäjä toimii.
Katso, mitä voit hallita
Admin API tarjoaa päätepisteitä seuraaville toiminnoille:
- Käyttäjät, tiimit ja ryhmät: luominen, haku, päivittäminen ja poistaminen.
- Jäsenyydet: henkilöiden lisääminen tiimeihin ja ryhmiin tai poistaminen niistä sekä roolien määrittäminen.
- Tarkastuslokit: tarkastuslokitapahtumien hakeminen ajastetusti.
- Tiimikutsut: henkilöiden kutsuminen tiimiin (myös organisaatiosi ulkopuolelta), odottavien kutsujen tarkastelu, olemassa olevan kutsulinkin hakeminen täsmällisellä sähköpostiosoitteella ja 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.
Tutustu Canva Admin API -dokumentaatioon ja vaihda asiakastunnuksesi käyttöoikeustunnisteeksi. Sen jälkeen voit aloittaa API-pyyntöjen tekemisen.
Jos haluat lisätietoja API-pyyntöjen todentamisesta ja OAuth 2.0 -haltijatunnisteiden käytöstä, jaa Canva Admin API:n todennusta käsittelevä dokumentaatio kehitystiimillesi.
Admin API:n tarkastuslokit
Admin API:n kautta tehdyt toiminnot kirjataan Admin API -asiakkaan, ei asiakkaan käynnistäneen yksittäisen pääkäyttäjän, nimiin.
Tarkastuslokeissa Actor-kentässä näkyvät Admin API -asiakkaan nimi ja asiakastunnus. Näin näet, mikä integraatio on tehnyt toiminnon.
Voit myös selvittää, kuka organisaation pääkäyttäjä loi, päivitti tai poisti tietyn API-asiakkaan.
Lisätietoja on artikkelissa 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.
Hyvä tietää
- Jokainen luomasi kutsu koskee yhtä tiimiä ja yhtä sähköpostiosoitetta.
- Kutsua voi käyttää kerran, ja se vanhenee 30 päivän kuluttua.
- 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 olemassa odottava kutsu, uuden kutsun luominen palauttaa saman kutsutietueen. Tällöin voimassaoloaika alkaa pyynnöstä uudelleen 30 päivästä ja kutsun rooliksi päivitetään pyydetty rooli.
Lisätietoja päätepisteistä on Canva Admin API -dokumentaatiossa.
Valitse Admin API tai SCIM
Sekä Admin API että SCIM tukevat käyttäjätilien hallintaa.
Admin API tukee käyttäjätilien hallinnan lisäksi muutakin Canvan organisaation hallintaa. Tähän kuuluvat tiimit, ryhmät, jäsenyydet ja tarkastuslokit.
SCIM tukee tavallista käyttäjätilien hallintaa ja käytöstä poistamista. Jos tarvitset vain tavallista 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 omia tai ulkoistettuja kehitysresursseja integraation rakentamiseen ja ylläpitoon. Canva ei tarjoa käyttöönoton tukea. Jos tiimisi ei pysty rakentamaan API-integraatiota, SCIM-hallinta sopii paremmin käyttäjähallinnan automatisointiin organisaatiossasi.
Tarvitseeko kaikilla organisaationi jäsenillä olla MFA tai kertakirjautuminen Admin API:n käyttöä varten?
Ei. Vain Admin API:n määrittävällä organisaation pääkäyttäjällä on oltava joko MFA käytössä tai kertakirjautumisen hallinnoima tili. Tilin on oltava sen organisaation hallinnoima tai omistama, jonka puolesta pääkäyttäjä toimii. Organisaation muilla jäsenillä ei tarvitse olla MFA:ta tai kertakirjautumista nimenomaan Admin API:n toimintaa varten.
Voiko organisaatiomme kutsua ulkopuolisia yhteistyökumppaneita Admin API:n avulla?
Kyllä. Organisaation pääkäyttäjät voivat kutsua Admin API:n avulla henkilöitä tiimeihin, myös ulkopuolisia yhteistyökumppaneita. Tiimisi nykyiset kutsu- ja verkkotunnusasetukset koskevat myös kutsumiasi henkilöitä.
Voimmeko hakea olemassa olevan kutsulinkin uudelleen luomatta uutta kutsua?
Kyllä. Voit hakea olemassa olevan kutsulinkin kutsuttavan täsmällisellä sähköpostiosoitteella luomatta uutta kutsua.
Oliko tästä apua?
Hyödyllinen
Ei hyödyllistä