API-key login

POST /apiKeyLogin

Authenticates an API-key connector and creates an App Connect CRM session. When a RingCentral access token is supplied, the server derives the RingCentral account and extension identities and can combine submitted values with administrator-managed credentials. A successful response returns userJwt as jwtToken; connector rejection is returned as HTTP 400 with an error or returnMessage.

Operation ID: postApiKeyLogin
Authorization: API key or API key

Parameters

Name	Location	Type	Required	Description
state	query	string	No	Ignored browser-client compatibility parameter. The server selects the connector from body.platform.

Request body

Connector and credential data used to create an App Connect user session.

Required: Yes

Content type: application/json

Schema: ApiKeyLoginRequest

{
  "platform": "exampleCRM",
  "apiKey": "example-api-key",
  "hostname": "crm.example.com"
}

Responses

Status	Description	Body
200	The connector credentials were accepted and an App Connect user token was issued.	ApiKeyLoginResponse
400	Bad request, missing authentication, or connector error.	ErrorResponse, string