Support
Access Sonoran CAD
Server Hosting
Sonoran CMS
Search…
Sonoran CAD
📱Download The App
Why Choose Sonoran CAD?
🏆
Why Choose Sonoran CAD?
Other Products
🖥
Server Hosting
📝
Sonoran CMS
📡
Sonoran Radio
Tutorials
Getting Started
Customization
Dispatching
Records Management
Administration
Other Features
Integration Capabilities
🗃
Paid Integration Resources
📺
Twitch Bodycam, Bot, & Lighting Integration
Database Sync and Merge
Discord Bot
Discord Rich Presence
Discord Webhooks
TeamSpeak 3 Integration
Stream Deck Integration
In-Game Integration Plugins
Framework Installation
Plugin Installation
Available Plugins
Call Commands
Check API ID
Civilian Integration
Dispatch Notify
ESX Support (QBCore/QBUS) and Auto-Fines
Fire Siren
FivePD
ForceReg
Kick
Locations
Live Map
Lookups
Postals
Smart Signs
Sonoran Radio (sonrad)
Tablet & Mini-CAD
TeamSpeak 3
Traffic Stop
Unit Status
WraithV2
Free Plugin Installation - Next Steps
Framework Development Documentation
Error Codes
🎮
Roblox ER:LC
Developer API Documentation
📖
API Integration
💵
Developer Bounties
🌎
Translation Support
Pricing
Pricing FAQ
View and Compare Plans
Roadmap
📋
Changelog
Other
Contact Us
Policy
Powered By
GitBook
Check API ID
Easily view your API ID with a command, and check if a given API ID is linked to an account.
This plugin utilizes API endpoints that require the
standard
version of Sonoran CAD or higher. For more information, view our
pricing
page.
Looking for VPS, web, or dedicated hosting? Check out our official
server hosting
!
This simple plugin exposes a check to see if an API ID exists. This is useful if you want to inform players they need to create an account on the CAD.
Installation
1. Download and Install the Framework
If you haven't already, be sure to install and configure the
plugin framework
first.
2. Download the Plugin
1.
Click
HERE
to download the API ID plugin .zip file.
3. Install the Plugin
1.
Follow the
standard plugin installation guide
for the API ID plugin.
Configuration
Config Option
Description
forceSetApiId
Enable the
tablet resource
to automatically set the user's
API ID
s when they log in.
Usage
Command
This plugin supplies the command
/apiid
which will print the player's primary identifier (the one they should use in Settings) to their console.
Function
Callback output parameter: true/false if API ID exists.
1
cadApiIdExists
(
"identifier_here"
,
callback
)
Copied!
Example
1
cadApiIdExists
(
"steam:1234567890"
,
function
(
exists
)
2
if
exists
then
3
print
(
"API ID exists!"
)
4
else
5
print
(
"API ID does not exist!"
)
6
end
7
end
)
Copied!
Event
This is a
server only
event.
Event Name:
SonoranCAD::apicheck:CheckPlayerLinked
Response Event:
SonoranCAD::apicheck:CheckPlayerLinkedResponse
Example
1
-- Request
2
TriggerEvent
(
"SonoranCAD::apicheck:CheckPlayerLinked"
,
source
,
identifier
)
3
4
-- Response
5
AddEventHandler
(
"SonoranCAD::apicheck:CheckPlayerLinkedResponse"
,
function
(
player
,
identifier
,
exists
)
6
print
((
"Player %s has API ID? %s"
):
format
(
player
,
exists
))
7
end
)
Copied!
Previous
Call Commands
Next
Civilian Integration
Last modified
1yr ago
Copy link
Edit on GitHub
Contents
Installation
1. Download and Install the Framework
2. Download the Plugin
3. Install the Plugin
Configuration
Usage
Command
Function
Event