Configurează și utilizează API-ul Canva administratorului
Notă: ai nevoie de o organizație în Canva pentru a folosi API-ul administrator. API-ul Admin funcționează la nivel de organizație.
Poți folosi Canva Admin API pentru a automatiza gestionarea organizației din propriile sisteme. Gestionează utilizatori, echipe, grupuri și apartenențe și recuperează evenimente din jurnalul de audit fără să îndeplinești manual aceste sarcini în Canva.
Verifică disponibilitatea
- Disponibil pentru Canva Enterprise, Canva Districts și Canva Campus.
- Accesibil administratorilor organizației.
- Disponibil pentru organizații cu o singură echipă sau cu mai multe echipe.
Verifică cerințele
Înainte de a configura Admin API, asigură-te că organizația ta îndeplinește aceste cerințe:
- Nivelul organizației: Admin API este destinat organizațiilor. Este disponibil pentru organizațiile cu o singură echipă sau cu mai multe echipe care au planurile Canva Enterprise, Canva Districts și Canva Campus.
- Cont de administrator al organizației: Numai administratorii organizației pot crea și gestiona clienți Admin API în setările Canva.
- Resurse de inginerie interne sau externalizate: organizația ta are nevoie de resurse de inginerie pentru a crea și întreține integrarea. Canva nu oferă asistență pentru implementare.
- Dacă echipa ta nu poate crea o integrare cu un API, asigurarea accesului prin SCIM este o soluție mai potrivită pentru automatizarea gestionării utilizatorilor din organizația ta.
- Cunoașterea structurii Canva: înainte de a crea integrarea, asigură-te că înțelegi clar cum sunt organizate organizația, echipele și grupurile în Canva.
- Autentificare multifactor (MFA) sau cont gestionat prin Single Sign-On (SSO): Administratorul organizației care configurează Admin API trebuie să aibă MFA activată sau un cont gestionat prin SSO. Contul trebuie să fie gestionat sau deținut de organizația în numele căreia acționează.
Află ce poți gestiona
Admin API oferă endpointuri pentru:
- Utilizatori, echipe și grupuri: creare, consultare, actualizare și ștergere.
- Apartenențe: adăugarea sau eliminarea persoanelor din echipe și grupuri și atribuirea rolurilor acestora.
- Jurnale de audit: recuperarea programată a evenimentelor din jurnalul de audit.
- Invitații în echipe: invitarea persoanelor într-o echipă (inclusiv a celor din afara organizației), vizualizarea invitațiilor în așteptare, recuperarea unui link de invitație existent folosind adresa de e-mail exactă și anularea invitațiilor.
Configurează Admin API
Un administrator al organizației creează un client Admin API și îl folosește pentru a apela API-ul.
Configurează API-ul administrator
- Accesați Setări.
- Selectați API administrator, apoi selectați Creează un client API.
- Denumiți clientul și selectați domeniile de aplicare care definesc ce poate accesa clientul.
- Selectați Continuare.
- Copiați ID-ul clientului și secretul clientului, apoi selectați Terminat.
- Schimbați acreditările pentru un token de acces, care este valid timp de patru ore.
- Utilizați tokenul de acces pentru a apela API-ul de administrare.
Urmează documentația Canva Admin APIi pentru a schimba acreditările clientului cu un token de acces și a începe să trimiți solicitări către API.
Pentru detalii tehnice despre autentificarea solicitărilor API și folosirea tokenurilor bearer OAuth 2.0, trimite echipei de inginerie documentația despre autentificarea Canva Admin API.
Înțelege jurnalele de audit din Admin API
Acțiunile efectuate prin Admin API sunt înregistrate pentru clientul Admin API, nu pentru administratorul care a apelat clientul.
În jurnalele de audit, câmpul Actor afișează numele și ID-ul clientului Admin API. Astfel, poți identifica integrarea care a efectuat o acțiune.
Poți identifica și administratorul organizației care a creat, actualizat sau șters un anumit client API.
Pentru mai multe informații, consultă Despre jurnalele de audit Canva.
Invită persoane în echipe
Administratorii organizației pot folosi Admin API pentru a invita persoane într-o echipă, inclusiv colaboratori externi din afara organizației.
De reținut
- Fiecare invitație pe care o creezi este pentru o singură echipă și o singură adresă de e-mail.
- Fiecare invitație poate fi folosită o singură dată și expiră după 30 de zile.
- În funcție de configurare, este posibil ca Canva să nu trimită automat un e-mail persoanei invitate. Dacă este necesar, trimite-i direct linkul invitației.
- Păstrează confidențialitatea linkurilor de invitație. Un link de invitație funcționează numai pentru adresa de e-mail pentru care a fost creat.
- Setările existente ale echipei tale privind invitațiile și domeniile se aplică în continuare persoanelor pe care le inviți.
- Dacă există deja o invitație în așteptare pentru persoana invitată, crearea unei invitații noi returnează aceeași înregistrare a invitației, resetează expirarea la 30 de zile de la solicitare și actualizează rolul persoanei invitate la cel solicitat.
Pentru detalii despre endpointuri, consultă documentația Canva Admin API.
Alege între Admin API și SCIM
Atât Admin API, cât și SCIM pot fi folosite pentru asigurarea accesului utilizatorilor.
Admin API permite gestionarea organizației Canva dincolo de asigurarea accesului utilizatorilor. Aici sunt incluse echipele, grupurile, apartenențele și jurnalele de audit.
SCIM permite asigurarea și revocarea accesului în mod standard. Dacă ai nevoie doar de asigurarea standard a accesului utilizatorilor sau echipa ta nu poate crea o integrare API personalizată, SCIM este o soluție mai potrivită pentru nevoile tale.
Întrebări frecvente
Organizația mea are nevoie de un dezvoltator pentru a folosi Admin API?
Da. Pentru a folosi Admin API, organizația ta trebuie să aibă resurse de inginerie interne sau externalizate pentru a crea și întreține integrarea. Canva nu oferă asistență pentru implementare. Dacă echipa ta nu poate crea o integrare cu un API, asigurarea accesului prin SCIM este o soluție mai potrivită pentru automatizarea gestionării utilizatorilor din organizația ta.
Toate persoanele din organizația mea au nevoie de MFA sau SSO pentru a folosi Admin API?
Nu. Numai administratorul organizației care configurează Admin API trebuie să aibă MFA activată sau un cont gestionat prin SSO. Contul trebuie să fie gestionat sau deținut de organizația în numele căreia acționează. Pentru ca Admin API să funcționeze, ceilalți membri ai organizației nu au nevoie în mod special de MFA sau SSO.
Poate organizația mea să invite colaboratori externi folosind Admin API?
Da. Administratorii organizației pot folosi Admin API pentru a invita persoane în echipe, inclusiv colaboratori externi. Setările existente ale echipei tale privind invitațiile și domeniile se aplică în continuare persoanelor pe care le inviți.
Putem recupera din nou un link de invitație existent fără să creăm o invitație nouă?
Da. Poți recupera un link de invitație existent folosind adresa de e-mail exactă a persoanei invitate, fără să generezi o invitație nouă.
Au fost de ajutor aceste informații?
Util
Inutil