Skonfiguruj interfejs API administratora Canva i korzystaj z niego

Canva Admin API umożliwia automatyzację zarządzania organizacją z poziomu własnych systemów. Zarządzaj użytkownikami, zespołami, grupami i członkostwem oraz pobieraj zdarzenia z dziennika kontrolnego bez konieczności wykonywania tych zadań ręcznie w Canvie.

• Dostępne w ramach planów Canva Enterprise, Canva Districts i Canva Campus.
• Dostępne dla administratorów organizacji.
• Dostępne dla organizacji z jednym zespołem i z wieloma zespołami.

Zanim skonfigurujesz Admin API, upewnij się, że Twoja organizacja spełnia te wymagania:

• Poziom organizacji: Admin API działa w zakresie organizacji. Jest dostępne dla organizacji z jednym zespołem i z wieloma zespołami w ramach planów Canva Enterprise, Canva Districts i Canva Campus.
• Konto administratora organizacji: Tylko administratorzy organizacji mogą tworzyć klientów Admin API i zarządzać nimi w ustawieniach Canvy.
• Własny lub zewnętrzny zespół inżynierów: Twoja organizacja potrzebuje zasobów inżynieryjnych, aby utworzyć i utrzymywać integrację. Canva nie zapewnia wsparcia przy wdrażaniu.
  • Jeśli Twój zespół nie może tworzyć integracji z użyciem API, lepszym rozwiązaniem do automatyzacji zarządzania użytkownikami w organizacji będzie provisioning SCIM.
• Znajomość struktury Canvy: Zanim utworzysz integrację, dobrze poznaj konfigurację organizacji, zespołów i grup w Canvie.
• Uwierzytelnianie wieloskładnikowe (MFA) lub konto 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 której imieniu działa ta osoba, lub należeć do tej organizacji.

Admin API udostępnia punkty końcowe do:

• Użytkowników, zespołów i grup: tworzenia, odczytywania, aktualizowania i usuwania.
• Członkostwa: dodawania osób do zespołów i grup oraz usuwania ich z nich, a także przypisywania ról.
• Dzienników kontrolnych: pobierania zdarzeń z dziennika kontrolnego zgodnie z harmonogramem.
• Zaproszeń do zespołu: zapraszania osób do zespołu (w tym osób spoza organizacji), wyświetlania oczekujących zaproszeń, pobierania istniejącego linku z zaproszeniem na podstawie dokładnego adresu e-mail oraz anulowania zaproszeń.

Administrator organizacji tworzy klienta Admin API i używa go do wysyłania żądań do API.

Postępuj zgodnie z dokumentacją Canva Admin API: dokumentację, aby wymienić dane logowania klienta na token dostępu i zacząć wysyłać żądania do API.

Udostępnij zespołowi inżynierów dokumentację uwierzytelniania Canva Admin API, aby poznał szczegóły techniczne uwierzytelniania żądań do API i korzystania z tokenów okaziciela OAuth 2.0.

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

W dziennikach kontrolnych pole „Aktor” 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 Dzienniki kontrolne Canvy.

Administratorzy organizacji mogą używać Admin API, aby zapraszać osoby do zespołu, w tym współpracowników z zewnątrz organizacji.

Warto wiedzieć

• Każde utworzone zaproszenie dotyczy jednego zespołu i jednego adresu e-mail.
• Każdego zaproszenia można użyć tylko raz, a jego ważność wygasa 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 bezpośrednio link z zaproszeniem.
• Nie udostępniaj linków z zaproszeniem publicznie. Link działa tylko dla adresu e-mail, dla którego został utworzony.
• Obowiązują dotychczasowe ustawienia zaproszeń i domeny w Twoim zespole.
• Jeśli dla zaproszonej osoby istnieje już oczekujące zaproszenie, utworzenie nowego zwróci ten sam rekord zaproszenia. Termin jego ważności zostanie ustawiony ponownie na 30 dni od zgłoszenia, a rola w zaproszeniu zostanie zmieniona na wskazaną.

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

Zarówno Admin API, jak i SCIM mogą obsługiwać provisioning użytkowników.

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

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

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

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

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 której imieniu 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ć współpracowników z zewnątrz za pomocą Admin API?

Tak. Administratorzy organizacji mogą używać Admin API, aby zapraszać osoby do zespołów, w tym współpracowników z zewnątrz. Obowiązują dotychczasowe ustawienia zaproszeń i domeny w Twoim zespole.

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

Tak. Możesz pobrać istniejący link z zaproszeniem, podając dokładny adres e-mail zaproszonej osoby, bez tworzenia nowego zaproszenia.