Community ID and API Keys

Explanation: API Keys and IDs

Within Sonoran CAD, there are two different types of API Keys that you will need to use, each serving a different purpose.

Community API Key

First, there is your community API Key which allows CAD's in-game integrations to send data to the correct community.

To find your community API Key, see Retrieving Your Credentials below.

This key will be placed in your config.json (for FiveM integration) or the Server Settings panel (for ER:LC integration).

User API ID

In addition to the community API Key, each user will also have their own API ID, which allows CAD to associate the user's in-game player with their Sonoran account. Generally, this will either be the user's Steam Hex, Discord ID, or Game License Key.

This API ID can be found in game by doing /apiid in game, if you have the apicheck plugin installed.

Every user will need to find their own API ID and add it to CAD as shown here.

Retrieving Your Credentials

Your community ID allows users to manually join your community.

Your community ID and API Key can be found in the Admin panel, under Advanced > In-Game Integration. Under the Web API section, your Community ID and API key will be listed as shown:

Click either box to copy its corresponding value to your clipboard.

Other Ways of Finding your Community ID

Your community ID is also listed in the following places:

1. In the side navigation bar while logged in

2. In the Admin panel under Advanced > Limits

Authenticating your Ownership

While requesting support from an official Sonoran team member, you may be asked to authenticate your community's ownership.

1. In the admin page, navigate to Advanced > Authenticate

2. Press the "Request Code" button

3. Your ownership authentication code will be displayed on the screen