API-Modul

Mit diesem Modul kannst du über die API mit einer App kommunizieren. Sobald du das API-Modul zusammen mit den API-Methoden in deiner App implementiert hast, kannst du über die Crowdin API auf die API-Methoden der App zugreifen, um die erforderlichen App-Daten zu verwalten (d. h. zu ändern oder zu löschen).

Zugriff

Du kannst Zugriff auf dieses Modul für eine der folgenden Benutzerkategorien gewähren:

Für Crowdin:

• Nur ich (also der Projektinhaber)
• Alle Projektmitglieder
• Ausgewählte Benutzer

Für Crowdin Enterprise:

• Nur Organisationsadministratoren
• Alle Benutzer in den Projekten der Organisation
• Ausgewählte Benutzer

Struktur

manifest.json

{
  "modules": {
    "api": [
      {
        "key": "your-api-module-key",
        "name": "API method name",
        "url": "/path",
        "method": "GET",
        "description": "Description of the API method",
        "documentationUrl": "/path/to/documentation"
      }
    ]
  }
}

Eigenschaften

key	Typ: string Erforderlich: ja Beschreibung: Kennung des Moduls innerhalb der Crowdin-App.
name	Typ: string Erforderlich: ja Beschreibung: Name der API-Methode.
url	Typ: string Erforderlich: ja Beschreibung: Die relative URL zur API-Methode.
method	Typ: string Zulässige Werte: GET, POST, PUT, PATCH, DELETE Erforderlich: ja Beschreibung: Typ der API-Methode.
description	Typ: string Beschreibung: Beschreibung der API-Methode.
documentationUrl	Typ: string Beschreibung: Die relative URL zur Dokumentation der API-Methode.