Create temporary web access key
Creates a temporary web key for time-limited, shareable lock access. B2C requires lock owner, B2B requires org match.
curl -X POST "https://api.spkey.co/locks/123/create-temp-key" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"tempKeyUuid": "example_string",
"accessMode": "public",
"allowedUserIds": [
"example_string"
],
"validFrom": "2024-12-25T10:00:00Z",
"validUntil": "2024-12-25T10:00:00Z",
"maxUses": "null",
"description": "example_string"
}'
import requests
import json
url = "https://api.spkey.co/locks/123/create-temp-key"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"tempKeyUuid": "example_string",
"accessMode": "public",
"allowedUserIds": [
"example_string"
],
"validFrom": "2024-12-25T10:00:00Z",
"validUntil": "2024-12-25T10:00:00Z",
"maxUses": "null",
"description": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/locks/123/create-temp-key", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"tempKeyUuid": "example_string",
"accessMode": "public",
"allowedUserIds": [
"example_string"
],
"validFrom": "2024-12-25T10:00:00Z",
"validUntil": "2024-12-25T10:00:00Z",
"maxUses": "null",
"description": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"tempKeyUuid": "example_string",
"accessMode": "public",
"allowedUserIds": [
"example_string"
],
"validFrom": "2024-12-25T10:00:00Z",
"validUntil": "2024-12-25T10:00:00Z",
"maxUses": "null",
"description": "example_string"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/locks/123/create-temp-key", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/locks/123/create-temp-key')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"tempKeyUuid": "example_string",
"accessMode": "public",
"allowedUserIds": [
"example_string"
],
"validFrom": "2024-12-25T10:00:00Z",
"validUntil": "2024-12-25T10:00:00Z",
"maxUses": "null",
"description": "example_string"
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null",
"tempKeyUuid": "example_string"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
/locks/{id}/create-temp-keyTarget server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
Lock ID (numeric)
The media type of the request body
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
Lock ID (numeric)
Body
publicuser-whitelist