| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | No | 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. |
| ContactEmail | body | string | Yes | Optional contact email to register for the key. Defaults to the logged in user's email. |
| Notes | body | string | Yes | Optional free text note for the key. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | No | The company the API key belongs to |
| ApiKey | form | Guid | No | The API key value to send in the x-api-key header |
| Active | form | bool | No | Whether the key is active |
| CreatedDate | form | DateTime | No | When the key was created |
| ExpiryDate | form | DateTime? | No | When the key expires, if ever |
| ContactEmail | form | string | Yes | Contact email registered for the key |
| Notes | form | string | Yes | Free text notes for the key |
| AllowedIpAddresses | form | string | Yes | Comma separated list of IP addresses the key is restricted to, if any |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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: api.bookmore.com
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"}