Hoppa till huvudinnehållet

Dokumentation

En backend, fyra vägar in. Varje avsnitt dokumenterar samma användningsfall, så ett koncept du lär dig i REST API är samma koncept i MCP och i CLI.

  • Komma igång

    Autentisering, arbetsytor, projekt och ditt första publicerade inlägg.

    Inte publicerat ännuDet här avsnittet är skrivet mot det levererade API:et och publiceras med det. Vi vill hellre visa dig ingenting än dokumentation för en slutpunkt som kan ändras.

  • REST API

    Resurser, paginering, idempotens, felkoder och hastighetsgränser.

    Inte publicerat ännuDet här avsnittet är skrivet mot det levererade API:et och publiceras med det. Vi vill hellre visa dig ingenting än dokumentation för en slutpunkt som kan ändras.

  • MCP-server

    Transport, OAuth, verktygskatalog, scopes och godkännandehandslaget.

    Inte publicerat ännuDet här avsnittet är skrivet mot det levererade API:et och publiceras med det. Vi vill hellre visa dig ingenting än dokumentation för en slutpunkt som kan ändras.

  • CLI

    Installera, autentisera och det maskinläsbara utdatakontraktet.

    Inte publicerat ännuDet här avsnittet är skrivet mot det levererade API:et och publiceras med det. Vi vill hellre visa dig ingenting än dokumentation för en slutpunkt som kan ändras.

  • Webhooks

    Händelsekatalog, signaturverifiering, omförsök och återleverans.

    Inte publicerat ännuDet här avsnittet är skrivet mot det levererade API:et och publiceras med det. Vi vill hellre visa dig ingenting än dokumentation för en slutpunkt som kan ändras.

  • Krav per plattform, kontotyper, gränser och kända begränsningar.

  • Felreferens

    Varje felkod, vad som orsakar det och vad man ska göra åt det.

    Inte publicerat ännuDet här avsnittet är skrivet mot det levererade API:et och publiceras med det. Vi vill hellre visa dig ingenting än dokumentation för en slutpunkt som kan ändras.

Vad du kan lita på

  • Varje skrivning kräver en idempotensnyckel. Att spela om en begäran med samma nyckel returnerar det ursprungliga resultatet istället för att skapa ett andra inlägg.
  • Varje fel har en stabil kod, en meddelandenyckel och sanerade detaljer. Koder ändrar inte betydelse mellan versioner.
  • Brytande ändringar får en ny version och ett meddelat utfasningsfönster. Additiva ändringar gör det inte.
  • Läsning, utarbetande, begära godkännande, schemaläggning och publicering är separata omfattningar. En legitimation får den minsta uppsättningen som gör sitt jobb.

API and MCP Terms