Dokumentacja
Jeden backend, cztery sposoby. Każda sekcja dokumentuje te same przypadki użycia, więc koncepcja, której nauczysz się w REST API, jest tą samą koncepcją w MCP i CLI.
Pierwsze kroki
Uwierzytelnianie, obszary robocze, projekty i Twój pierwszy opublikowany post.
Jeszcze nieopublikowaneTa sekcja została napisana w oparciu o dostarczony interfejs API i publikowana wraz z nim. Wolelibyśmy nie pokazywać niczego poza dokumentacją punktu końcowego, który może ulec zmianie.
API REST
Zasoby, paginacja, idempotencja, kody błędów i limity szybkości.
Jeszcze nieopublikowaneTa sekcja została napisana w oparciu o dostarczony interfejs API i publikowana wraz z nim. Wolelibyśmy nie pokazywać niczego poza dokumentacją punktu końcowego, który może ulec zmianie.
Serwer MCP
Transport, OAuth, katalog narzędzi, zakresy i uzgadnianie zatwierdzenia.
Jeszcze nieopublikowaneTa sekcja została napisana w oparciu o dostarczony interfejs API i publikowana wraz z nim. Wolelibyśmy nie pokazywać niczego poza dokumentacją punktu końcowego, który może ulec zmianie.
CLI
Zainstaluj, uwierzytelnij i wygeneruj kontrakt wyjściowy do odczytu maszynowego.
Jeszcze nieopublikowaneTa sekcja została napisana w oparciu o dostarczony interfejs API i publikowana wraz z nim. Wolelibyśmy nie pokazywać niczego poza dokumentacją punktu końcowego, który może ulec zmianie.
Webhooki
Katalog zdarzeń, weryfikacja podpisu, ponowne próby i ponowne dostarczenie.
Jeszcze nieopublikowaneTa sekcja została napisana w oparciu o dostarczony interfejs API i publikowana wraz z nim. Wolelibyśmy nie pokazywać niczego poza dokumentacją punktu końcowego, który może ulec zmianie.
Według wymagań platformy, typów kont, limitów i znanych ograniczeń.
Odniesienie do błędu
Każdy kod błędu, jego przyczyna i co z tym zrobić.
Jeszcze nieopublikowaneTa sekcja została napisana w oparciu o dostarczony interfejs API i publikowana wraz z nim. Wolelibyśmy nie pokazywać niczego poza dokumentacją punktu końcowego, który może ulec zmianie.
Na czym możesz polegać
- Każdy zapis wymaga klucza idempotencji. Ponowne odtworzenie żądania z tym samym kluczem zwraca oryginalny wynik, zamiast tworzyć drugi post.
- Każdy błąd zawiera stabilny kod, klucz wiadomości i oczyszczone szczegóły. Kody nie zmieniają znaczenia pomiędzy wersjami.
- Przełomowe zmiany otrzymują nową wersję i ogłoszony okres wycofania. Zmiany addytywne nie.
- Czytanie, redagowanie, prośba o zatwierdzenie, planowanie i publikowanie to odrębne zakresy. Poświadczenie pobiera najmniejszy zestaw, który spełnia swoje zadanie.