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.

import Foundation
import ServiceStack

// @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)
public class CreateApiKey : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * 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 var contactEmail:String

    /**
    * Optional free text note for the key.
    */
    // @ApiMember(Description="Optional free text note for the key.")
    public var notes:String

    required public init(){}
}

public class ApiKeyResponse : Codable
{
    /**
    * The company the API key belongs to
    */
    // @ApiMember(Description="The company the API key belongs to")
    public var companyId:String

    /**
    * 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 var apiKey:String

    /**
    * Whether the key is active
    */
    // @ApiMember(Description="Whether the key is active")
    public var active:Bool

    /**
    * When the key was created
    */
    // @ApiMember(Description="When the key was created")
    public var createdDate:Date

    /**
    * When the key expires, if ever
    */
    // @ApiMember(Description="When the key expires, if ever")
    public var expiryDate:Date?

    /**
    * Contact email registered for the key
    */
    // @ApiMember(Description="Contact email registered for the key")
    public var contactEmail:String

    /**
    * Free text notes for the key
    */
    // @ApiMember(Description="Free text notes for the key")
    public var notes:String

    /**
    * 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 var allowedIpAddresses:String

    required public init(){}
}

Swift CreateApiKey DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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