EntwicklerdokumentationAPI v1

Erste Schritte

Entwickeln Sie auf Ihrem Arbeitsbereich.

Verbinden Sie Ihre Tools mit Squario über eine versionierte JSON-API. Entdecken Sie das Schema, lesen und ändern Sie Daten mit Ihren App-Berechtigungen.

Eine API, Ihr Arbeitsbereich

Die REST API verwendet HTTPS und JSON. API-Schlüssel gehören zu einem Mitglied in einem Arbeitsbereich. Ihre Basis-URL endet bereits auf /functions/v1/public-api/v1; kopieren Sie sie aus Einstellungen → API und ergänzen Sie den Endpointpfad aus diesen Anleitungen. Die Dokumentation liegt unter /docs auf der Squario-Website.

  • Authentifizieren Sie sich mit Authorization: Bearer <API_KEY>.
  • Eine Liste enthält data und Paginierungsinformationen in meta.
  • Ein gelesener oder geschriebener Datensatz steht in einem data-Objekt.
  • Verfolgen Sie eine Anfrage mit X-Request-Id.

Berechtigungen folgen dem Schlüssel

Jede Operation handelt als das Mitglied, das den Schlüssel erstellt hat. Mitgliedschaft, Ressourcenberechtigungen und Feldbeschränkungen werden serverseitig geprüft. Lese- und Schreibzugriff, zugelassene Ressourcen und IP-Adressen eines Schlüssels können diesen Zugriff einschränken. Sie können ihn nicht erweitern.

REST API oder MCP

Beide Verbindungen nutzen denselben Aktionskern für Ressourcen. Wählen Sie REST für eine Integration, die Sie steuern, oder MCP für einen KI-Client mit Zustimmung des Mitglieds.

REST API oder MCP
VerbindungZugangsmittelGeeignet fürVerbrauch
REST APIAPI-Schlüssel eines MitgliedsServerintegrationen, Importe und SynchronisierungMonatliches API-Anfragekontingent
MCPOAuth-2.1-FreigabeExterne KI-Clients und AssistentenKI-Credits des Arbeitsbereichs

Mit einer Leseanfrage beginnen

Rufen Sie /me auf, entdecken Sie die Ressourcen Ihres Schlüssels und beschreiben Sie die benötigte Ressource. Das aktuelle Schema enthält die verfügbaren benutzerdefinierten Felder Ihres Arbeitsbereichs. Die Endpointreferenz dokumentiert alle Routen sowie Anfrage- und Antwortschemas.