Skip to content

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.

Access

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

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"
}
]
}
}

Properties

key

Type: string

Required: yes

Description: Module identifier within the Crowdin app.

name

Type: string

Required: yes

Description: API method name.

url

Type: string

Required: yes

Description: The relative URL to the API method.

method

Type: string

Allowed values: GET, POST, PUT, PATCH, DELETE

Required: yes

Description: API method type.

description

Type: string

Description: Description of the API method.

documentationUrl

Type: string

Description: The relative URL to the API method documentation.

Was this page helpful?