Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

createApiKeys - API Key Module Reference

This documentation provides a reference to the createApiKeys method. This belongs to the API Key Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

createApiKeys(data, sharedContext?): Promise<ApiKeyDTO[]>#

This method creates API keys.

Example#

Code
1const apiKey = await apiKeyModuleService.createApiKeys([{2  title: "Development API key",3  type: "publishable",4  created_by: "user_123"5}])

Parameters#

dataCreateApiKeyDTO[]
The API keys to be created.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<ApiKeyDTO[]>
The created API keys.

createApiKeys(data, sharedContext?): Promise<ApiKeyDTO>#

This method creates an API key.

Example#

Code
1const apiKey = await apiKeyModuleService.createApiKeys({2  title: "Development API key",3  type: "publishable",4  created_by: "user_123"5})

Parameters#

dataCreateApiKeyDTO
The API key to be created.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<ApiKeyDTO>
The created API key.
Was this page helpful?