Get Login Page

Retrieve public login-page community details by custom URL or community ID.

GET https://api.sonorancad.com/v2/general/login-page

Rate limit: 10 requests per minute Authenticated v2 endpoints are rate limited per API key rather than per IP address.

Return public login-page details for a community. This endpoint does not require bearer authentication.

Query Parameters

Name

Type

Default

Description

communityId

string

Optional

Use the community ID instead of url. Provide exactly one.

url

string

Optional

Use the community website or login URL instead of communityId.

Example Request

-- luarocks install sonoran.lua
-- For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CAD,
  communityId = "YOUR_COMMUNITY_ID",
  apiKey = "YOUR_API_KEY",
  defaultServerId = 1
})

local response = sonoran.cad:getLoginPageV2({
    communityId = 'YOUR_COMMUNITY_ID',
  })

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

Use this tab only when calling the v2 API from the server side of an in-game FiveM resource.

Sonoran.lua and Sonoran.js: use the sonorancad export to get the ready CAD client.
Sonoran.Net: FiveM exports do not return a .NET client. Read the Sonoran CAD convars and create a fresh client.
Sonoran.py: FiveM does not run Python resources; use the Python tab for external integrations.

The API key is stored in sonoran_apiKey as a protected FiveM convar. FiveM restricts a convar after add_convar_permission is configured, so only explicitly permitted resources can read it. Grant another resource access with add_convar_permission your-resource-name read sonoran_apiKey. If you change the API key in config.json, fully restart the sonorancad resource before reading the updated convar value.

Sonoran.lua

local cad = exports["sonorancad"]:getCadClient()

Sonoran.js

const cad = exports["sonorancad"].getCadClient();

Sonoran.Net

// dotnet add package Sonoran.Net
using CitizenFX.Core.Native;
using Sonoran;

var communityId = API.GetConvar("sonoran_communityID", "");
var apiKey = API.GetConvar("sonoran_apiKey", "");
var serverIdRaw = API.GetConvar("sonoran_serverId", "1");
var serverId = int.TryParse(serverIdRaw, out var parsedServerId) ? parsedServerId : 1;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = communityId,
    apiKey = apiKey,
    defaultServerId = serverId
});

After getting the Lua export client:

local response = cad:getLoginPageV2({
    communityId = 'YOUR_COMMUNITY_ID',
  })

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

// npm install @sonoransoftware/sonoran.js
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
const Sonoran = require('@sonoransoftware/sonoran.js');

(async () => {
  const instance = new Sonoran.Instance({
    communityId: 'YOUR_COMMUNITY_ID',
    apiKey: 'YOUR_API_KEY',
    product: Sonoran.productEnums.CAD,
    serverId: 1,
  });

  const response = await instance.cad.getLoginPageV2({
    communityId: 'YOUR_COMMUNITY_ID',
  });
  console.log(response);
})();

# pip install Sonoran.py
# Sonoran.py is for external Python integrations; FiveM resources should use the SonoranCADFiveM tab.
from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CAD,
    serverId=1,
)

response = instance.cad.getLoginPageV2({
    "communityId": 'YOUR_COMMUNITY_ID',
  })

print(response.success)
print(response.data if response.success else response.reason)

// dotnet add package Sonoran.Net
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab; .NET creates a fresh client from convars.
using Sonoran;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = "YOUR_COMMUNITY_ID",
    apiKey = "YOUR_API_KEY",
    defaultServerId = 1
});

var response = await sonoran.Cad.getLoginPageV2(new GetLoginPageV2Query
{
    CommunityId = "YOUR_COMMUNITY_ID"
});

Console.WriteLine(response.success);
Console.WriteLine(response.data);

Import this YAML into Postman with Import -> Raw text to create a single-endpoint request collection for this route.

openapi: "3.0.3"
info:
  title: "Sonoran CAD v2 - Get Login Page"
  version: "1.0.0"
  description: "Retrieve public login-page community details by custom URL or community ID."
servers:
  -
    url: "https://api.sonorancad.com"
paths:
  /v2/general/login-page:
    get:
      summary: "Get Login Page"
      operationId: "getLoginPage"
      responses:
        200:
          description: "Successful response"
          content:
            application/json:
              schema:
                type: "object"
              example:
                comId: "examplecad"
                name: "Example CAD"
                timezone: "America/Phoenix"
                customLoginUrl: "https://portal.examplecad.com/login"
      parameters:
        -
          description: "Use the community ID instead of `url`. Provide exactly one."
          name: "communityId"
          in: "query"
          schema:
            type: "string"
          required: false
        -
          description: "Use the community website or login URL instead of `communityId`."
          name: "url"
          in: "query"
          schema:
            type: "string"
          required: false

Response

Successful requests return application/json.

{
  "comId": "examplecad",
  "name": "Example CAD",
  "timezone": "America/Phoenix",
  "customLoginUrl": "https://portal.examplecad.com/login"
}

PreviousGet Info NextLocal Endpoints

Last updated 2 months ago

Was this helpful?