Skonfiguruj interfejs API administratora Canva i korzystaj z niego

Za pomocą Canva Admin API możesz automatyzować zarządzanie organizacją z poziomu własnych systemów. Zarządzaj użytkownikami, zespołami, grupami i członkostwami oraz pobieraj zdarzenia z dziennika kontrolnego — bez konieczności wykonywania tych czynności ręcznie w Canvie.

• Dostępne w planach Canva Enterprise, Canva Districts i Canva Campus.
• Dostępne dla administratorów organizacji.
• Dostępne dla organizacji z jednym zespołem i wielu zespołowych.

Przed skonfigurowaniem Admin API upewnij się, że Twoja organizacja spełnia następujące wymagania:

• Warstwa organizacji: Admin API działa w zakresie organizacji. Jest dostępne dla organizacji z jednym zespołem i wielu zespołowych w planach Canva Enterprise, Canva Districts i Canva Campus.
• Konto administratora organizacji: Tylko administratorzy organizacji mogą tworzyć klienty Admin API i zarządzać nimi w ustawieniach Canvy.
• Własny lub zewnętrzny zespół inżynieryjny: Twoja organizacja potrzebuje zasobów inżynieryjnych do zbudowania i utrzymania integracji. Canva nie zapewnia wsparcia przy wdrażaniu.
  • Jeśli Twój zespół nie może zbudować integracji z użyciem API, provisioning SCIM będzie lepszym rozwiązaniem do automatyzacji zarządzania użytkownikami w organizacji.
• Znajomość struktury Canvy: Zanim utworzysz integrację, dobrze poznaj sposób organizacji zespołów i grup w swojej organizacji w Canvie.
• Konto z uwierzytelnianiem wieloskładnikowym (MFA) lub zarządzane przez pojedyncze logowanie (SSO): Administrator organizacji konfigurujący Admin API musi mieć włączone MFA lub korzystać z konta zarządzanego przez SSO. Konto musi być zarządzane przez organizację, w imieniu której działa ta osoba, lub należeć do tej organizacji.

Admin API udostępnia punkty końcowe umożliwiające:

• Użytkownikami, zespołami i grupami: tworzenie, odczytywanie, aktualizowanie i usuwanie.
• Członkostwami: dodawanie i usuwanie osób z zespołów i grup oraz przypisywanie im ról.
• Dziennikami kontrolnymi: pobieranie zdarzeń z dziennika kontrolnego według harmonogramu.
• Zaproszeniami do zespołu: zapraszanie osób do zespołu (również spoza organizacji), wyświetlanie oczekujących zaproszeń, pobieranie istniejącego linku z zaproszeniem na podstawie dokładnego adresu e-mail i anulowanie zaproszeń.

Administrator organizacji tworzy klienta Admin API i używa go do wywoływania API.

Aby wymienić dane logowania klienta na token dostępu i zacząć wysyłać żądania do API, skorzystaj z dokumentacji Canva Admin API.

Aby poznać szczegóły techniczne dotyczące uwierzytelniania żądań API i korzystania z tokenów okaziciela OAuth 2.0, udostępnij zespołowi inżynieryjnemu dokumentację uwierzytelniania Canva Admin API.

Działania wykonane za pomocą Admin API są przypisywane klientowi Admin API, a nie administratorowi, który go użył.

W dziennikach kontrolnych pole „Actor” wyświetla nazwę i identyfikator klienta Admin API. Dzięki temu możesz sprawdzić, która integracja wykonała dane działanie.

Możesz też sprawdzić, który administrator organizacji utworzył, zaktualizował lub usunął danego klienta API.

Więcej informacji znajdziesz w artykule Informacje o dziennikach kontrolnych Canvy.

Administratorzy organizacji mogą używać Admin API do zapraszania osób do zespołu, w tym współpracowników spoza organizacji.

Warto wiedzieć

• Każde utworzone zaproszenie dotyczy jednego zespołu i jednego adresu e-mail.
• Z każdego zaproszenia można skorzystać tylko raz. Wygasa ono po 30 dniach.
• W zależności od konfiguracji Canva może nie wysłać zaproszonej osobie automatycznej wiadomości e-mail. W razie potrzeby udostępnij jej link z zaproszeniem bezpośrednio.
• Nie udostępniaj linków z zaproszeniami publicznie. Link działa tylko dla adresu e-mail, dla którego został utworzony.
• Do zapraszanych osób nadal mają zastosowanie obowiązujące ustawienia zaproszeń i domen Twojego zespołu.
• Jeśli zaproszona osoba ma już oczekujące zaproszenie, utworzenie nowego zwróci ten sam wpis zaproszenia, przedłuży jego ważność do 30 dni od momentu żądania i zaktualizuje przypisaną rolę zgodnie z żądaniem.

Szczegółowe informacje o punktach końcowych znajdziesz w dokumentacji Canva Admin API.

Zarówno Admin API, jak i SCIM mogą służyć do provisioningu użytkowników.

Admin API umożliwia zarządzanie organizacją Canva w szerszym zakresie niż sam provisioning użytkowników. Obejmuje to zespoły, grupy, członkostwa i dzienniki kontrolne.

SCIM obsługuje standardowy provisioning i odbieranie uprawnień. Jeśli potrzebujesz tylko standardowego provisioningu użytkowników lub Twój zespół nie może zbudować niestandardowej integracji API, SCIM będzie lepszym rozwiązaniem.

Czy moja organizacja potrzebuje programisty, aby korzystać z Admin API?

Tak. Do zbudowania i utrzymania integracji z Admin API Twoja organizacja potrzebuje własnego lub zewnętrznego zespołu inżynieryjnego. Canva nie zapewnia wsparcia przy wdrażaniu. Jeśli Twój zespół nie może zbudować integracji z użyciem API, provisioning SCIM będzie lepszym rozwiązaniem do automatyzacji zarządzania użytkownikami w organizacji.

Czy wszyscy w mojej organizacji muszą korzystać z MFA lub SSO, aby używać Admin API?

Nie. Tylko administrator organizacji konfigurujący Admin API musi mieć włączone MFA lub korzystać z konta zarządzanego przez SSO. Konto musi być zarządzane przez organizację, w imieniu której działa ta osoba, lub należeć do tej organizacji. Pozostali członkowie organizacji nie muszą korzystać z MFA ani SSO, aby Admin API działało.

Czy moja organizacja może zapraszać zewnętrznych współpracowników za pomocą Admin API?

Tak. Administratorzy organizacji mogą używać Admin API do zapraszania osób do zespołów, w tym zewnętrznych współpracowników. Do zapraszanych osób nadal mają zastosowanie obowiązujące ustawienia zaproszeń i domen Twojego zespołu.

Czy możemy ponownie pobrać istniejący link z zaproszeniem bez tworzenia nowego zaproszenia?

Tak. Możesz pobrać istniejący link z zaproszeniem, używając dokładnego adresu e-mail zaproszonej osoby, bez generowania nowego zaproszenia.