BokaMera.API.Host

CreateApiKey

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/apikeys	Create a new API key for the logged in user's company	Generates a new API key for the company of the currently logged in user and returns it. A company administrator can only create keys for their own company.

// @ts-nocheck

export class ApiKeyResponse
{
    /** @description The company the API key belongs to */
    // @ApiMember(Description="The company the API key belongs to")
    public CompanyId: string;

    /** @description The API key value to send in the x-api-key header */
    // @ApiMember(Description="The API key value to send in the x-api-key header")
    public ApiKey: string;

    /** @description Whether the key is active */
    // @ApiMember(Description="Whether the key is active")
    public Active: boolean;

    /** @description When the key was created */
    // @ApiMember(Description="When the key was created")
    public CreatedDate: string;

    /** @description When the key expires, if ever */
    // @ApiMember(Description="When the key expires, if ever")
    public ExpiryDate?: string;

    /** @description Contact email registered for the key */
    // @ApiMember(Description="Contact email registered for the key")
    public ContactEmail: string;

    /** @description Free text notes for the key */
    // @ApiMember(Description="Free text notes for the key")
    public Notes: string;

    /** @description Comma separated list of IP addresses the key is restricted to, if any */
    // @ApiMember(Description="Comma separated list of IP addresses the key is restricted to, if any")
    public AllowedIpAddresses: string;

    public constructor(init?: Partial<ApiKeyResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="Returned if the current user is not authenticated", StatusCode=401)
// @ApiResponse(Description="Returned if the current user does not have the required role", StatusCode=403)
export class CreateApiKey implements ICompany
{
    /** @description The company to create the API key for. Defaults to the logged in user's company. Only a SuperAdmin may specify a company other than their own; for other roles this value is ignored. */
    // @ApiMember(Description="The company to create the API key for. Defaults to the logged in user's company. Only a SuperAdmin may specify a company other than their own; for other roles this value is ignored.")
    public CompanyId?: string;

    /** @description Optional contact email to register for the key. Defaults to the logged in user's email. */
    // @ApiMember(Description="Optional contact email to register for the key. Defaults to the logged in user's email.")
    public ContactEmail: string;

    /** @description Optional free text note for the key. */
    // @ApiMember(Description="Optional free text note for the key.")
    public Notes: string;

    public constructor(init?: Partial<CreateApiKey>) { (Object as any).assign(this, init); }
}

TypeScript CreateApiKey DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /apikeys HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ContactEmail":"String","Notes":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Active":false,"ExpiryDate":"0001-01-01T00:00:00","ContactEmail":"String","Notes":"String","AllowedIpAddresses":"String"}