sparxstar-sirus-context/docs/contracts/sirus-api-seed.v1.json at main · Starisian-Technologies/sparxstar-sirus-context · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
{
  "contract": "docs/contracts/sirus-api-contract.v1.json",
  "version": "1.0.0",
  "baseUrl": "/wp-json/sparxstar/v1",
  "headers": {
    "X-WP-Nonce": "seed-wp-rest-nonce",
    "Content-Type": "application/json"
  },
  "requests": {
    "registerDevice": {
      "method": "POST",
      "path": "/device",
      "body": {
        "visitor_id": "seed-visitor-01",
        "environment_data": {
          "browser_name": "Firefox",
          "browser_version": "126.0",
          "os": "Linux",
          "os_version": "6.8",
          "device_type": "desktop",
          "network_effective_type": "4g",
          "time_zone": "Etc/UTC",
          "screen_resolution": "1920x1080",
          "canvas_hash": "seed-canvas-hash"
        }
      }
    },
    "getContext": {
      "method": "GET",
      "path": "/context",
      "query": {
        "device_id": "CLI"
      }
    },
    "issuePulse": {
      "method": "POST",
      "path": "/pulse",
      "body": {
        "device_id": "CLI",
        "resource_sensitivity": "LEVEL_2",
        "request_id": "seed-request-01"
      }
    },
    "getIdentity": {
      "method": "GET",
      "path": "/identity",
      "query": {
        "device_id": "CLI"
      }
    },
    "getSession": {
      "method": "GET",
      "path": "/session",
      "query": {
        "device_id": "CLI"
      }
    },
    "recordClientReport": {
      "method": "POST",
      "path": "/client-report",
      "body": {
        "error_type": "js_error",
        "error_message": "Seed client smoke report",
        "device_id": "CLI",
        "context": {
          "component": "seed-smoke",
          "severity": "low"
        }
      }
    }
  },
  "expectedResponses": {
    "registerDevice": 200,
    "getContext": 200,
    "issuePulse": 201,
    "getIdentity": 200,
    "getSession": 200,
    "recordClientReport": 202
  }
}