Interfejsy API realizacji SaaS na platformie handlowej firmy Microsoft

  • Artykuł

Interfejsy API realizacji SaaS umożliwiają wydawcom, znanym także jako niezależni dostawcy oprogramowania (ISV), publikowanie i sprzedawanie aplikacji SaaS w witrynie Microsoft AppSource, witrynie Azure Marketplace i witrynie Azure Portal. Te interfejsy API umożliwiają aplikacjom niezależnego dostawcy oprogramowania uczestnictwo we wszystkich kanałach z obsługą handlu: bezpośrednim, prowadzonym przez partnera (reseller) i kierowanym przez pole. Integracja z tymi interfejsami API jest wymagana do tworzenia i publikowania transakcyjnej oferty SaaS w Centrum partnerskim.

Aby dowiedzieć się więcej na temat interfejsów API realizacji SaaS, zalecamy również przeczytanie następujących artykułów:

Przepływy interfejsu API

Dostawcy oprogramowania muszą zaimplementować następujące przepływy interfejsu API, dodając je do kodu usługi SaaS, aby zachować ten sam stan subskrypcji zarówno dla niezależnych dostawców oprogramowania, jak i firmy Microsoft:

  • Przepływ strony docelowej: firma Microsoft powiadamia wydawcę, że oferta SaaS wydawcy została zakupiona przez klienta na platformie handlowej.
  • Przepływ aktywacji: program Publisher powiadamia firmę Microsoft o skonfigurowaniu nowo zakupionego konta SaaS po stronie wydawcy.
  • Przepływ aktualizacji: zmiana zakupionego planu lub liczby zakupionych miejsc lub obu tych opcji.
  • Wstrzymanie i przywrócenie przepływu: wstrzymanie zakupionej oferty SaaS w przypadku, gdy forma płatności klienta nie jest już prawidłowa. Wstrzymana oferta może zostać przywrócona po rozwiązaniu problemu z formą płatności.
  • Przepływy elementu webhook: firma Microsoft powiadamia wydawcę o zmianach subskrypcji SaaS i anulowaniu wyzwalanym przez klienta po stronie firmy Microsoft.

W przypadku anulowania zakupionej subskrypcji SaaS integracja jest opcjonalna, ponieważ może to być wykonywane przez klienta po stronie firmy Microsoft.

Poprawna integracja z interfejsami API realizacji SaaS ma kluczowe znaczenie dla upewnienia się, że:

  • Klienci końcowi, którzy kupili ofertę SaaS wydawcy, są rozliczani prawidłowo przez firmę Microsoft.
  • Klienci końcowi otrzymują prawidłowe środowisko użytkownika, zakup, konfigurowanie i używanie subskrypcji SaaS zakupionych na platformie handlowej oraz zarządzanie nimi.

Te interfejsy API umożliwiają ofertom wydawcy uczestnictwo we wszystkich kanałach z obsługą handlu:

  • Direct
  • Prowadzone przez partnera (odsprzedawca, Dostawca rozwiązań w chmurze [CSP])
  • Prowadzone przez pole

W scenariuszu odsprzedawcy (CSP) dostawca CSP kupuje ofertę SaaS w imieniu klienta końcowego. Oczekuje się, że klient korzysta z oferty SaaS, ale dostawca CSP jest jednostką, która wykonuje następujące zadania:

  • Rozlicza klienta
  • Zmienia plany subskrypcji/ilość zakupionych miejsc
  • Anuluje subskrypcje

Program Publisher nie jest wymagany do zaimplementowania żadnego z przepływów wywołań interfejsu API w inny sposób w tym scenariuszu.

Aby uzyskać więcej informacji, zobacz Dostawca rozwiązań w chmurze (CSP).

Ostrzeżenie

Interfejsy API realizacji SaaS w wersji 1 zostały wycofane; Zamiast tego użyj wersji 2. Wersja 1 jest obecnie obsługiwana tylko w celu obsługi istniejących wydawców, a dokumentacja wersji 1 nie jest już dostępna. Jeśli uważasz, że musisz uzyskać do niego dostęp, możesz wysłać wiadomość e-mail na adres saas-api-v1@microsoft.com.

Uwaga

Interfejsy API realizacji SaaS mają być wywoływane tylko z usługi zaplecza wydawcy. Integracja z interfejsami API bezpośrednio ze strony internetowej wydawcy nie jest obsługiwana. Należy używać tylko przepływu uwierzytelniania typu service-to-service.

Następne kroki

Samouczki wideo