Opcjonalne API projektu
Wyświetl zatwierdzone operacje aplikacji, gdy będą potrzebne.
Przejrzyj zakres API dla kwalifikującego się projektu i odróżnij planowane trasy od już zbudowanych endpointów.
Traktuj API jako zdefiniowaną opcję projektu
- Sprawdź opcję
Sprawdź dostępność API i odpowiadającą jej ofertę projektu.
- Określ zakres tras
Doprecyzuj, które operacje biznesowe ma udostępniać API.
- Sprawdź katalog tras
Sprawdź metodę, ścieżkę oraz planowany lub aktywny status każdej trasy.
Dodaj API, gdy Twój projekt go potrzebuje
API projektu to opcjonalna część oferty. Przed aktywacją przejrzyj jego zakres i warunki, zamiast zakładać, że każda aplikacja je zawiera.
Narzędzia API porządkują proponowane trasy według obszarów biznesowych. Wyjaśnienia pomagają określić, co ma robić każda operacja przed jej implementacją.
Odróżnij planowane trasy od działających endpointów
Przygotuj dostęp dla innego systemu. Projekt może wymagać, aby inna aplikacja korzystała z jego operacji biznesowych. Przejrzyj zakres i ofertę opcjonalnego API, zamiast zakładać, że każda funkcja jest udostępniana automatycznie. Uzgodnione operacje określają, do czego integracja ma mieć dostęp.
Sprawdź katalog tras. Katalog pokazuje metodę, ścieżkę, opis i stan każdej trasy. Pomaga odróżnić proponowany zakres od endpointów zarejestrowanych jako działające. To praktyczny punkt odniesienia podczas śledzenia przygotowania API.
Wybierz właściwy kierunek integracji. Korzystanie z API innego dostawcy i udostępnianie własnej aplikacji to różne potrzeby. Pierwszą obejmują połączenia zewnętrzne, a uzgodnione udostępnienie obejmuje API projektu. Wybierz drogę odpowiednią do potrzebnej wymiany biznesowej.
Odróżnij udostępnione API od połączenia zewnętrznego
API projektu udostępnia uzgodnione operacje Twojej aplikacji. Połączenie zewnętrzne opisuje, jak Twoja aplikacja korzysta z innej usługi; służą one różnym potrzebom.
Korzystaj z katalogu tras, aby sprawdzić metodę, ścieżkę i to, czy endpoint jest planowany, czy działa. Ta prezentacja nie aktywuje API dla Twojego projektu.
Oceń opcję API pod kątem konkretnej potrzeby
Określ, kto będzie korzystać z danych projektu i jakich operacji wymaga ta integracja. Pomaga to odróżnić opcjonalny zakres API od połączenia z istniejącą usługą zewnętrzną.
W kwalifikującym się projekcie sprawdź zaplanowane trasy i stan ich budowy. Zanim uznasz endpoint za dostępny dla integracji, potwierdź odpowiednią usługę i środowisko.
Od opcjonalnego zakresu do zweryfikowanego udostępnienia
Sprawdź dostępność i warunki. Sprawdź opcję API w rzeczywistej ofercie projektu. Przed aktywacją zdecyduj, czy aplikacja potrzebuje takiego udostępnienia.
Doprecyzuj operacje. Przejrzyj proponowane operacje biznesowe i odpowiedz na pytania o ich oczekiwane zachowanie. Śledź stan przygotowania i budowy.
Sprawdź, co jest uruchomione. Sprawdź katalog tras i opublikowaną dokumentację referencyjną aktywowanego projektu. Zaplanowana trasa nie jest działającym endpointem.
Określ zakres integracji, zanim dodasz API
Wyjaśnij, jakich operacji potrzebuje inny system, i przejrzyj warunki opcji. API powinno służyć uzgodnionej wymianie biznesowej.
Pytania dotyczące opcjonalnego API projektu
To opcja, której dostępność i cena są podane w rzeczywistej ofercie. Aplikacja może działać bez jej aktywowania. Ta prezentacja nie udostępnia ani nie włącza API dla Twojego projektu.
Opisuje zamierzoną operację, która nie jest jeszcze zarejestrowana jako działający endpoint. Przed rozpoczęciem integracji sprawdź stan w katalogu i faktycznie opublikowaną dokumentację referencyjną.
Widoki API projektu pokazują obszary do udostępnienia, pytania, infrastrukturę i stany budowy. Spełnij wskazane wymagania wstępne i przejrzyj wynikowy katalog tras.
Korzystaj z dokumentacji referencyjnej API aktywowanego projektu i odpowiedniego środowiska. Nie wyprowadzaj endpointu ani przykładu uwierzytelniania wyłącznie z zaplanowanej trasy.
Opisują inną usługę, z której korzysta Twoja aplikacja. Ten kierunek integracji różni się od udostępniania operacji Twojej aplikacji przez API projektu.