Authentication

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

The RocketCAD API relies on API Keys to authenticate requests. API Keys can be created and customized from your Owner Panel > Integration 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.

200

{
    "status": "success",
    "response": {
        "success": true,
        "message": "This API Key is valid & associated with an active community."
        "requestID": "OLV213JN6XL1BLS"
    }
}

400 In the event you fail to provide an API Key as a Query Parameter, you will likely receive a 400: Bad Request error.

{
    "statusCode": 400,
    "body": {
        "status": "MISSING_DATA",
        "message": "Missing parameter for workflow ping: parameter api_key"
    }
}

404 While rare, a 404: Not Found error typically indicates there is a temporary API Outage on our end. We encourage you to Contact Support if you encounter this erorr.

{
    "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.

pageSecurity & Privacy

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

pageErrors