🖥️
RocketCAD Docs
RocketCADVPS HostingSupport DiscordFollow us on Twitter!
  • Home
  • Helpful Links
    • Join our Discord
    • Support Center
    • Gaming VPS Hosting
  • About RocketCAD
    • How We Started
    • RocketCAD Pricing
    • Frequently Asked Questions
    • Getting Unlimited for Free
    • Security & Privacy
  • Getting Started with v6
    • Our Mission
    • MDT Walkthrough
      • MDT Dashboard
      • Viewing an Assignment
    • CAD Walkthrough
      • Creating a Call
      • Editing a Call
      • Using the Command Line
      • Managing Units
      • Creating and Managing BOLOs
      • Information Searches
    • Integration Resources
      • Upgrading your Integration
      • Troubleshooting Integration Issues
    • Getting Started as an Owner
  • Walkthroughs & Tutorials
    • System
      • Portal
    • Admins
    • Owners
      • How to Connect LiveMap to RocketCAD
      • How to Cancel your Community
      • How to Change Your Plan
    • Error Messages
      • API Error: 1A
      • API Error: 1B
      • Error 2A - Missing Permissions
      • Tracking Location Errors
      • We do not have the information on your last patrol
      • Patrol Configuration Error
  • How To's
    • How to Find Steam Hex
    • Portal
      • How to Login to Patrol
      • How to Enable 2-Factor Authentication
      • How to Delete Patrol Configurations
  • RocketCAD Useful Info
    • Data & Metric Collection
    • Command Line Commands
    • Call-Takers Guide
  • RocketCAD Development
    • Changelog
  • Developers
    • Introduction to the API
    • Authentication
    • Errors
      • Troubleshooting API Errors
    • RequestIDs
    • New Endpoints
      • 911
      • Panic Button
      • Location Ping
    • Previous MDT Functions
      • Vehicle Search
      • Person Search
      • Log User Off
      • Set Notepad
      • Firearm Search
      • Toggle Emergency Tone
      • Create Call
      • Create BOLO
      • Toggle Broadcast Tone
      • Change AOP
      • Assign to Call
      • Update Unit Status
Powered by GitBook
On this page

Was this helpful?

  1. Developers

Authentication

Let's learn more about authenticating with the RocketCAD API.

PreviousIntroduction to the APINextErrors

Last updated 3 years ago

Was this helpful?

The RocketCAD API relies on API Keys to authenticate requests. API Keys can be created and customized from your menu.

Your API Keys may carry many permissions, be sure to keep them secure. Do not publicly share your API Key or reveal it in Github, client-side code, etc.

The standard RocketCAD API authentication will appear like the following example:

Standard RocketCAD API Authentication Example

POST https://api.therocketcad.com/api/1.1/wf/ping?api_key=DEVELOPER_TESTING

In this example, you are only required to supply a valid API Key, such as the example above.

Query Parameters

Name
Type
Description

api_key

string

The API Key query parameter is required for all requests. API Keys can be generated from the Owner Panel > API Access tab.

Request Body

Name
Type
Description

communityID

string

The communityID body parameter may be required in specific contexts.

serverID

string

The serverID body parameter may be requierd in specific contexts.

{
    "status": "success",
    "response": {
        "success": true,
        "message": "This API Key is valid & associated with an active community."
        "requestID": "OLV213JN6XL1BLS"
    }
}
{
    "statusCode": 400,
    "body": {
        "status": "MISSING_DATA",
        "message": "Missing parameter for workflow ping: parameter api_key"
    }
}
{
    "statusCode": 404,
    "body": {
        "status": "NOT_FOUND",
        "message": "Workflow not found ping"
    }
}

All API requests must be made over HTTPS. Requests made over HTTP or without authentication as described above will fail.

You may learn more about RocketCAD's User, Community and API Security Practices below.

If you're ready to continue, let's learn more about Errors.

Owner Panel > Integration
Security & Privacy
Errors