Key Creation API
The Key Creation API service generates a new key under an existing organization, which must be securely stored. The request must include Api-Key
, belonging to the active organization with which the new key will be associated. By default, the new key is assigned the role "standard" and a status of "active".
Endpoint Details:
- URL: https://signals.smarte.pro/signals/v1/key/createsignalapikey
- Method: POST
Input Parameters
Required Headers:
Header | Value Type | Required | Description |
---|---|---|---|
Api-key | string | yes | Admin API key |
Content-Type | string | yes | Must be application/json |
Request Body Parameters:
Parameter | Type | Required | Description |
---|---|---|---|
email | string | yes | Email ID associated with the new key |
Sample
Request
curl --location 'https://signals.smarte.pro/signals/v1/key/createsignalapikey' \
--header 'Content-Type: application/json' \
--header 'Api-Key: WG+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxOwZcyVwvAibM=' \
--data-raw '{
"email": "dev.udi_user@smarte.pro"
}'
Success Response
{
"message": "Key generated successfully",
"data": {
"keyId": "222c424f-6e56-4ab1-94eb-8a0e41490831",
"email": "dev.udi_user@smarte.pro",
"role": "standard",
"status": "active",
"apiKey": "mIGxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxJHY"
}
}