Advance the app-service PIN campaign from one reported shadow
Reads the reported shadow for device liveness and for the ack of an in-flight SetCredential, and emits the one step the campaign takes (send, clear, verdict, give up, re-drive, retire) or NO_EVENT.
curl -X POST "https://api.spkey.co/matter-devices/example_string/ProcessAppPinTick" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"reported": {},
"requirePinRemote": "null",
"hasStoredPin": true,
"projected": "null",
"pinMinLength": "null",
"pinMaxLength": "null"
}'
import requests
import json
url = "https://api.spkey.co/matter-devices/example_string/ProcessAppPinTick"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"reported": {},
"requirePinRemote": "null",
"hasStoredPin": true,
"projected": "null",
"pinMinLength": "null",
"pinMaxLength": "null"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/matter-devices/example_string/ProcessAppPinTick", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"reported": {},
"requirePinRemote": "null",
"hasStoredPin": true,
"projected": "null",
"pinMinLength": "null",
"pinMaxLength": "null"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"reported": {},
"requirePinRemote": "null",
"hasStoredPin": true,
"projected": "null",
"pinMinLength": "null",
"pinMaxLength": "null"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/matter-devices/example_string/ProcessAppPinTick", 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/matter-devices/example_string/ProcessAppPinTick')
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 = '{
"reported": {},
"requirePinRemote": "null",
"hasStoredPin": true,
"projected": "null",
"pinMinLength": "null",
"pinMaxLength": "null"
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": {
"type": "AppPinSendRequested",
"data": {
"deviceId": "example_string",
"thingName": "John Doe",
"timestamp": 3.14,
"messageId": "example_string",
"attempt": 42,
"userIndex": 42,
"credentialIndex": 42,
"pinMinLength": "null",
"pinMaxLength": "null"
}
},
"appPinCampaign": "null"
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
/matter-devices/{id}/ProcessAppPinTickTarget 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.
Matter Device ID
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
Matter Device ID
Body
Responses
The single step the campaign took, or null when this shadow changed nothing