circuit-api-documentation/index.html at main · Gizra/circuit-api-documentation · 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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Circuit Auction Backoffice API Documentation</title>
  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet">
  <link href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/themes/prism.min.css" rel="stylesheet" />
  <style>
      body { padding-top: 70px; background-color: #f8f9fa; }
      .navbar-brand { font-weight: bold; }
      .main-content { padding: 2rem; }
      pre { background: #f4f4f4; padding: 1rem; border-radius: 0.375rem; }
      code { font-size: 0.9em; }
      .endpoint { font-family: 'Courier New', monospace; background: #e9ecef; padding: 0.2rem 0.4rem; border-radius: 0.25rem; font-size: 0.9em; }
      .badge-method { font-size: 0.7em; padding: 0.3em 0.6em; }
      .section-title { border-bottom: 2px solid #0d6efd; padding-bottom: 0.5rem; margin-bottom: 1.5rem; }
      .copy-btn { position: absolute; top: 0.5rem; right: 0.5rem; font-size: 0.8rem; }
  </style>
</head>
<body>

<!-- Navbar -->
<nav class="navbar navbar-expand-lg navbar-dark bg-primary fixed-top">
  <div class="container-fluid">
    <a class="navbar-brand" href="index.html">Circuit Auction API v1.0</a>
  </div>
</nav>

<div class="main-content">
      <h1 class="section-title">Circuit Auction Backoffice API Documentation</h1>
      <p class="lead">Comprehensive REST API for managing auction operations including clients, orders, items, sales, and more.</p>

      <div id="base-url" class="mb-5">
        <h2>Base URL</h2>
        <pre><code class="language-text">https://backoffice.ddev.site/api/v1.0/</code></pre>
      </div>

      <div id="authentication" class="mb-5">
        <h2>Authentication</h2>
        <p>All endpoints require a Bearer token obtained via the authentication endpoint.</p>

        <div class="card mb-3">
          <div class="card-body">
            <h5 class="card-title"><span class="badge bg-success badge-method">GET</span> <span class="endpoint">/api/login-token</span></h5>
            <p class="mb-3">Authenticate using HTTP Basic Authentication to obtain an access token.</p>

            <h6>Request Headers:</h6>
            <pre><code class="language-http">GET /api/login-token HTTP/1.1
Host: backoffice.ddev.site
Authorization: Basic base64(email:password)</code></pre>

            <h6 class="mt-3">Example using JavaScript:</h6>
            <pre><code class="language-javascript">const email = 'user@example.com';
const password = 'securePassword123';
const credentials = btoa(`${email}:${password}`);

const response = await fetch('https://backoffice.ddev.site/api/login-token', {
  method: 'GET',
  headers: {
    'Authorization': `Basic ${credentials}`
  }
});</code></pre>

            <h6 class="mt-3">Example using cURL:</h6>
            <pre><code class="language-bash">curl -X GET "https://backoffice.ddev.site/api/login-token" \
  -H "Authorization: Basic $(echo -n 'user@example.com:securePassword123' | base64)"</code></pre>

            <h6 class="mt-3">Response:</h6>
            <pre><code class="language-json">{
  "data": [{
    "id": "123",
    "token": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
    "type": "access_token",
    "uid": "456",
    "expire": 1735689600
  }]
}</code></pre>

            <h6 class="mt-3">Using the Token:</h6>
            <p>Use the <code>token</code> value in the <code>Authorization</code> header for all subsequent API requests:</p>
            <pre><code class="language-http">GET /api/v1.0/datatable-clients HTTP/1.1
Host: backoffice.ddev.site
Authorization: Bearer abc123def456ghi789jkl012mno345pqr678stu901vwx234yz</code></pre>

            <div class="alert alert-info mt-3 mb-0">
              <h6 class="alert-heading"><i class="fas fa-info-circle"></i> Token Behavior</h6>
              <ul class="mb-0">
                <li>Tokens are reused if a valid unexpired token exists for the user</li>
                <li>A new token is created only if no valid token exists or if the existing token has expired</li>
                <li>Check the <code>expire</code> field (Unix timestamp) to know when the token will expire</li>
                <li>Expired tokens are automatically deleted when attempting to use them</li>
              </ul>
            </div>
          </div>
        </div>
      </div>

      <div class="row">
        <div class="col-md-6 mb-4">
          <div class="card h-100">
            <div class="card-body">
              <h5 class="card-title">Clients</h5>
              <p class="card-text">Manage client records, connections, and merging.</p>
              <a href="clients/list.html" class="btn btn-primary">View Clients API</a>
            </div>
          </div>
        </div>
        <div class="col-md-6 mb-4">
          <div class="card h-100">
            <div class="card-body">
              <h5 class="card-title">Client Addresses</h5>
              <p class="card-text">Manage client addresses, set default addresses, and handle address types.</p>
              <a href="addresses/list.html" class="btn btn-primary">View Addresses API</a>
            </div>
          </div>
        </div>
        <div class="col-md-6 mb-4">
          <div class="card h-100">
            <div class="card-body">
              <h5 class="card-title">Consignments</h5>
              <p class="card-text">Manage consignor inventory, commissions, shipping methods, and workflow tracking.</p>
              <a href="consignments/list.html" class="btn btn-primary">View Consignments API</a>
            </div>
          </div>
        </div>
        <div class="col-md-6 mb-4">
          <div class="card h-100">
            <div class="card-body">
              <h5 class="card-title">Orders</h5>
              <p class="card-text">Create and manage bidder orders, invoices, credit notes, and payments.</p>
              <a href="orders/list.html" class="btn btn-primary">View Orders API</a>
            </div>
          </div>
        </div>
        <div class="col-md-6 mb-4">
          <div class="card h-100">
            <div class="card-body">
              <h5 class="card-title">Items</h5>
              <p class="card-text">Handle auction items, lots, images, dimensions, and bulk operations.</p>
              <a href="items/list.html" class="btn btn-primary">View Items API</a>
            </div>
          </div>
        </div>
        <div class="col-md-6 mb-4">
          <div class="card h-100">
            <div class="card-body">
              <h5 class="card-title">Sales</h5>
              <p class="card-text">Manage auctions, sessions, statistics, and catalog parts.</p>
              <a href="sales/list.html" class="btn btn-primary">View Sales API</a>
            </div>
          </div>
        </div>
        <div class="col-md-6 mb-4">
          <div class="card h-100">
            <div class="card-body">
              <h5 class="card-title">Transactions</h5>
              <p class="card-text">Record and manage payment transactions, cheques, and wire transfers.</p>
              <a href="transactions/list.html" class="btn btn-primary">View Transactions API</a>
            </div>
          </div>
        </div>
        <div class="col-md-6 mb-4">
          <div class="card h-100">
            <div class="card-body">
              <h5 class="card-title">Notes</h5>
              <p class="card-text">Manage notes and comments attached to items, sales, orders, and clients with document support.</p>
              <a href="notes/list.html" class="btn btn-primary">View Notes API</a>
            </div>
          </div>
        </div>
        <div class="col-md-6 mb-4">
          <div class="card h-100">
            <div class="card-body">
              <h5 class="card-title">Files & Queue</h5>
              <p class="card-text">Handle file uploads, queue monitoring, and bulk operations.</p>
              <a href="files/get.html" class="btn btn-primary">View Files API</a>
            </div>
          </div>
        </div>
        <div class="col-md-6 mb-4">
          <div class="card h-100 border-info">
            <div class="card-body">
              <h5 class="card-title"><i class="fas fa-broadcast-tower text-info"></i> Pusher Events</h5>
              <p class="card-text">Real-time WebSocket events for entity updates, queue processing, bulk operations, and more.</p>
              <a href="pusher-events.html" class="btn btn-info">View Pusher Events</a>
            </div>
          </div>
        </div>
      </div>

      <hr class="my-5">

      <h2>Documentation</h2>
      <div class="row">
        <div class="col-md-4 mb-3">
          <div class="card">
            <div class="card-body">
              <h6 class="card-title"><i class="fas fa-filter"></i> Common Parameters</h6>
              <p class="card-text small">Pagination, sorting, filtering, and field selection.</p>
              <a href="common.html" class="btn btn-sm btn-outline-primary">Learn More</a>
            </div>
          </div>
        </div>
        <div class="col-md-4 mb-3">
          <div class="card">
            <div class="card-body">
              <h6 class="card-title"><i class="fas fa-exclamation-triangle"></i> Error Handling</h6>
              <p class="card-text small">Error responses, status codes, and troubleshooting.</p>
              <a href="errors.html" class="btn btn-sm btn-outline-primary">Learn More</a>
            </div>
          </div>
        </div>
        <div class="col-md-4 mb-3">
          <div class="card">
            <div class="card-body">
              <h6 class="card-title"><i class="fas fa-database"></i> Data Types</h6>
              <p class="card-text small">Dates, currency, booleans, and data formats.</p>
              <a href="data-types.html" class="btn btn-sm btn-outline-primary">Learn More</a>
            </div>
          </div>
        </div>
        <div class="col-md-4 mb-3">
          <div class="card">
            <div class="card-body">
              <h6 class="card-title"><i class="fas fa-broadcast-tower"></i> Pusher Events</h6>
              <p class="card-text small">Real-time WebSocket events for live updates.</p>
              <a href="pusher-events.html" class="btn btn-sm btn-outline-primary">Learn More</a>
            </div>
          </div>
        </div>
      </div>

      <hr class="my-5">

      <h2>Key Features</h2>
      <div class="row">
        <div class="col-md-6">
          <ul class="list-group">
            <li class="list-group-item"><i class="fas fa-check text-success"></i> Advanced filtering, sorting, and pagination</li>
            <li class="list-group-item"><i class="fas fa-check text-success"></i> Bulk operations for efficiency</li>
            <li class="list-group-item"><i class="fas fa-check text-success"></i> File and image uploads</li>
            <li class="list-group-item"><i class="fas fa-check text-success"></i> Activity logging and audit trails</li>
            <li class="list-group-item"><i class="fas fa-check text-success"></i> Comprehensive error handling</li>
          </ul>
        </div>
        <div class="col-md-6">
          <ul class="list-group">
            <li class="list-group-item"><i class="fas fa-check text-success"></i> RESTful API design</li>
            <li class="list-group-item"><i class="fas fa-check text-success"></i> JWT authentication</li>
            <li class="list-group-item"><i class="fas fa-check text-success"></i> JSON request/response format</li>
            <li class="list-group-item"><i class="fas fa-check text-success"></i> Queue-based background jobs</li>
            <li class="list-group-item"><i class="fas fa-check text-success"></i> Real-time Pusher WebSocket events</li>
            <li class="list-group-item"><i class="fas fa-check text-success"></i> Rate limiting protection</li>
          </ul>
        </div>
      </div>

      <div class="mt-5">
        <h2>Available Endpoints</h2>
        <div class="row">
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-users fa-2x text-primary mb-2"></i>
                <h6>Clients</h6>
                <small class="text-muted">6 endpoints</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-map-marker-alt fa-2x text-info mb-2"></i>
                <h6>Addresses</h6>
                <small class="text-muted">5 endpoints</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-handshake fa-2x text-warning mb-2"></i>
                <h6>Consignments</h6>
                <small class="text-muted">1 endpoint</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-file-invoice fa-2x text-success mb-2"></i>
                <h6>Orders</h6>
                <small class="text-muted">7 endpoints</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-box fa-2x text-warning mb-2"></i>
                <h6>Items</h6>
                <small class="text-muted">4 endpoints</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-gavel fa-2x text-danger mb-2"></i>
                <h6>Sales</h6>
                <small class="text-muted">4 endpoints</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-credit-card fa-2x text-info mb-2"></i>
                <h6>Transactions</h6>
                <small class="text-muted">2 endpoints</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-sticky-note fa-2x text-warning mb-2"></i>
                <h6>Notes</h6>
                <small class="text-muted">1 endpoint</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-file fa-2x text-secondary mb-2"></i>
                <h6>Files</h6>
                <small class="text-muted">1 endpoint</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-clock fa-2x text-primary mb-2"></i>
                <h6>Queue</h6>
                <small class="text-muted">1 endpoint</small>
              </div>
            </div>
          </div>
          <div class="col-md-3 col-sm-6 mb-3">
            <div class="card text-center">
              <div class="card-body">
                <i class="fas fa-layer-group fa-2x text-success mb-2"></i>
                <h6>Bulk</h6>
                <small class="text-muted">1 endpoint</small>
              </div>
            </div>
          </div>
        </div>
      </div>

      <div class="mt-5">
        <small class="text-muted">Last Updated: October 30, 2025 | API Version: 1.0</small>
      </div>
    </div>

<script src="assets/js/sidebar.js"></script>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-core.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script>
  // Copy buttons
  document.querySelectorAll('pre code').forEach(block => {
    const button = document.createElement('button');
    button.className = 'btn btn-sm btn-outline-secondary copy-btn';
    button.textContent = 'Copy';
    button.onclick = () => {
      navigator.clipboard.writeText(block.textContent);
      button.textContent = 'Copied!';
      setTimeout(() => button.textContent = 'Copy', 2000);
    };
    block.parentElement.style.position = 'relative';
    block.parentElement.appendChild(button);
  });
</script>
</body>
</html>