Create new lock
Creates a new lock aggregate
curl -X POST "https://api.spkey.co/locks/123/CreateLock" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"index": 42,
"uuid": "example_string",
"serialNumber": "example_string",
"vendorName": "John Doe",
"ownerId": "example_string",
"keys": [
{
"uuid": "example_string",
"indexNumber": 42,
"userId": "example_string"
}
]
}'
import requests
import json
url = "https://api.spkey.co/locks/123/CreateLock"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"index": 42,
"uuid": "example_string",
"serialNumber": "example_string",
"vendorName": "John Doe",
"ownerId": "example_string",
"keys": [
{
"uuid": "example_string",
"indexNumber": 42,
"userId": "example_string"
}
]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/locks/123/CreateLock", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"index": 42,
"uuid": "example_string",
"serialNumber": "example_string",
"vendorName": "John Doe",
"ownerId": "example_string",
"keys": [
{
"uuid": "example_string",
"indexNumber": 42,
"userId": "example_string"
}
]
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"index": 42,
"uuid": "example_string",
"serialNumber": "example_string",
"vendorName": "John Doe",
"ownerId": "example_string",
"keys": [
{
"uuid": "example_string",
"indexNumber": 42,
"userId": "example_string"
}
]
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/locks/123/CreateLock", 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/CreateLock')
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 = '{
"index": 42,
"uuid": "example_string",
"serialNumber": "example_string",
"vendorName": "John Doe",
"ownerId": "example_string",
"keys": [
{
"uuid": "example_string",
"indexNumber": 42,
"userId": "example_string"
}
]
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null"
}
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
POST
/locks/{id}/CreateLockPOST
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token (JWT)
Bearer Tokenstring
RequiredJWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
RequiredAPI key for B2B organization access. Provided during organization onboarding.
API key for B2B organization access. Provided during organization onboarding.
path
idinteger
RequiredLock ID (numeric)
Content-Typestring
RequiredThe media type of the request body
Options: application/json
indexinteger
RequiredLock index number
uuidstring
RequiredLock UUID
serialNumberstring
Serial number
vendorNamestring
Vendor/manufacturer name
ownerIdstring
Owner user ID
keysarray
Initial keys
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
header
X-API-Keystring
RequiredAPI Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
idinteger
RequiredLock ID (numeric)
Body
application/json
indexinteger
RequiredLock index number
uuidstring
RequiredLock UUID
serialNumberstring
Serial number
vendorNamestring
Vendor/manufacturer name
ownerIdstring
Owner user ID
Responses
successboolean
RequiredaggregateIdstring
Requiredversionnumber
Requiredeventobject,null
Requiredsuccessboolean
RequiredaggregateIdstring
Requiredversionnumber
Requiredeventobject,null
Requiredsuccessboolean
RequiredAllowed values:
falseerrorstring
Requiredmessagestring
RequiredWas this page helpful?