Dokumentacja referencyjna API

Wszystkie poniższe punkty końcowe, schematy i formaty błędów są generowane przez samo DUST API i udostępniane na żywo, więc zawsze odpowiadają wdrożonemu API.

Osadzona dokumentacja referencyjna

Ładowanie dokumentacji referencyjnej API…Wczytywanie dokumentacji referencyjnej trwa dłużej niż zwykle. Do czasu jego zakończenia możesz otworzyć ją w nowej karcie.

Otwórz pełną dokumentację referencyjną w nowej karcie

Od czego zacząć

• Szybki start — twoje pierwsze uwierzytelnione żądanie, od początku do końca.
• Uwierzytelnianie — klucze API, wymiana tokenów i nagłówki kontekstu.
• Konwencje — paginacja i kontekst żądania wspólny dla wszystkich punktów końcowych.
• Błędy — koperta błędu, kody, które faktycznie napotkasz, i sposoby radzenia sobie z nimi.
• Przewodniki po DICE — jak te same rekordy wyglądają i działają w aplikacji internetowej.

Wskazówka

Klient TypeScript jest generowany z tej samej specyfikacji, więc jego typy zawsze odpowiadają temu, co opisuje dokumentacja referencyjna.

Kopie specyfikacji

Dostępne są dwie kopie specyfikacji:

Źródło	URL	Aktualność
DUST API (na żywo)	https://apid.dustid.io/api/openapi.json	Zawsze odpowiada wdrożonemu API.
Ta witryna dokumentacji	/openapi.json	Generowana podczas budowania tej witryny, z tego samego źródła co API.

Do generowania klientów lub walidacji żądań używaj kopii na żywo — zawsze odpowiada ona wdrożonemu API. Kopia z witryny jest generowana na nowo przy każdym wydaniu dokumentacji i jest wygodna, gdy już tu przeglądasz dokumentację.