API Module

This module allows you to communicate with an app via the API. Once you implement the API module along with the API methods in your app, you’ll be able to access the app’s API methods via the Crowdin API to manage (i.e., modify or delete) the necessary app data.

You can grant access to this module to one of the following user categories:

For Crowdin:

• Only me (i.e., project owner)
• All project members
• Selected users

For Crowdin Enterprise:

• Only organization admins
• All users in the organization projects
• Selected users

Structure

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

Properties