# Contributor ID Link

> Link Crowdin volunteers to your reward system and download a Top Members report enriched with their external IDs

URL: https://store.crowdin.com/contributor-id-link
Identifier: contributor-id-link
Category: Manager Productivity, Translator Productivity
Type: App
Author: Awesome Crowdin
OpenAPI spec: https://store.crowdin.com/contributor-id-link/openapi.json

Lets your Crowdin volunteers attach an ID from your reward system to their Crowdin profile, so you can pay them out without chasing the right username over chat or email.

Use it for anything you give contributors: in-game items, custom skins, NFTs or other crypto, store credit, or an internal ID from your own reward platform.

If you also want to recognise contributors with certificates, there are dedicated apps for that:

* [Certificates](https://store.crowdin.com/certificates) for crowdin.com (already installed).
* [Volunteer Certificates](https://store.crowdin.com/volunteer-certificates) for Crowdin Enterprise.

This app handles the "where do I send the reward" part.

## How it works

### 1. Install

When you install the app, Crowdin asks which projects to enable it in. Pick only the projects where you actually want to reward volunteers.

The app adds three modules to those projects. One of them, the *Contributing* tab, is what volunteers see. It is restricted to managers by default so you can test things first. After you have configured it and checked it works, open the app settings in Crowdin and switch the *Contributing* module visibility to *All project members*.

Keep the other two modules (the manager Report and the API endpoint) restricted to managers.

![Installing and configuring Crowdin app](https://developers.app.crowdin.net/api/media/file/061d7c08-fdbd-415c-9cdc-b925824d471e.png)

### 2. Configure

Open a project, go to *Reports > Contributor ID Link*, switch to the *Settings* tab and fill in:

* The input label, placeholder and helper text. This is the wording volunteers see, for example "Your in-game wallet address" or "Your Discord user ID".
* The program rules, in Markdown. Describe how your reward program works (who qualifies, what counts, what they get, how often you pay out) and, in the same text, explain step by step how to find the right ID in your system. Volunteers will not guess.

![Configuring Contributor ID Link Crowdin app](https://developers.app.crowdin.net/api/media/file/7361450f-786d-48e9-b18e-fc92e20d1b8d.png)

### 3. Volunteers submit

Volunteers open the project, click the *Contributing* tab, read your rules, paste their ID and save. They can come back and update it any time.

Crowdin will not notify them about the new tab on its own, so tell your volunteers about it the way you usually reach them (project announcement, Discord, mailing list, etc.) and point them at the *Contributing* tab.

![](https://developers.app.crowdin.net/api/media/file/40de9265-8e9d-4405-8b32-60a290abf3c2.png)

### 4. Pull the report

When you want to reward people (monthly, quarterly, or on demand):

1. Open *Reports > Contributor ID Link > Report*.
2. Pick the unit (words, strings, characters), the period and optionally a target language.
3. Click Generate. You get the standard Crowdin Top Members report with one extra column: the external ID each contributor linked.
4. Download as CSV and hand it to whatever script pays them out.

![](https://developers.app.crowdin.net/api/media/file/d61fd79f-1d6d-4325-9fc2-55501cbcf021.png)

### 5. Or automate it

The same data is available through Crowdin's REST API, so you can run payouts on a schedule from your own server. Authenticate with a Crowdin Personal Access Token that has the `application` scope:

```
GET https://api.crowdin.com/api/v2/applications/contributor-id-link/api/top-members
    ?projectId={projectId}&dateFrom={iso8601}&dateTo={iso8601}&unit=words
```

Response is the normal Top Members payload with an `externalId` field added to each row.

## Resources

- [API Reference](https://3q45iyhpv3w4xfjb3aqach7tpy0ukkfw.lambda-url.us-east-1.on.aws/api-docs): [OpenAPI spec](https://3q45iyhpv3w4xfjb3aqach7tpy0ukkfw.lambda-url.us-east-1.on.aws/api-docs/swagger.json)