PlainApp
API குறிப்பு

Main GraphQL HTTP

உள்நுழைந்த அமர்வுக்கான மறைகுறியாக்கப்பட்ட கோரிக்கைகள்.

key = Base64Decode(session.token)அங்கீகரிக்கப்பட்ட அமர்வு; c-id = clientId

கிளையன்ட்
https://<host>:<port>/graphql
சேவையகம்

POST /graphql

c-id: 706c6169-3b80-8f42-9a61-4e312e54d001

HTTP · binary

JSON({ requestId, query, variables })

requestId என்பது கோரிக்கை நேரத்தைக் கொண்ட UUIDv7. variables, operationName மற்றும் extensions விருப்பமானவை.

ஒவ்வொரு கோரிக்கைக்கும் புதிய UUIDv7 requestId-ஐப் பயன்படுத்தவும். அதன் நேரம் சேவையக நேரத்திலிருந்து ±30 நிமிடங்களுக்குள் இருக்க வேண்டும். நகல் UUID மதிப்புகள் நினைவகத்தில் நீக்கப்படுகின்றன.

XChaCha20-Poly1305 · புலத்தில் சுட்டியை வைக்கவும் அல்லது தட்டவும்
1 / 2

மீளனுப்பல் தாக்குதல் தடுப்பு

requestId = UUIDv7()JSON { requestId, query, variables } → authenticated encryption
↓ POST /graphql
அங்கீகரித்து மறைகுறி நீக்கவும்session.token✕ → நிராகரிக்கவும்
↓
UUIDv7 நேரத்தைச் சரிபார்க்கவும்|serverTime − requestId timestamp| ≤ 30 min✕ → நிராகரிக்கவும்
↓
செயல்படுத்தும் முன் requestId-ஐப் பதிவு செய்யவும்session → request-ID set
✓ ↓GraphQL-ஐச் செயல்படுத்தவும்
✕ ↓மீண்டும் பயன்படுத்திய requestId-ஐ நிராகரிக்கவும்
Bearer API Token: உடல் மறைகுறியாக்கம் இல்லாமல் HTTPS வழியாக JSON →
நூலக அழைப்புகள்

Desktop குறியீட்டுப் பகுதிகள். graphqlRequestPayload, UUIDv7 requestId-ஐ உருவாக்குகிறது. HTTP_REQUEST, POST மற்றும் தருக்க முனையத்தைப் பிணைக்கும் AAD கொண்டு JSON-ஐ மறைகுறியாக்கி, பதில் பிணைப்பைச் சரிபார்க்கவும்.

typescript
// plain-desktop/src/lib/api/gql-client.ts
const payload = graphqlRequestPayload(query, variables)
const requestBody = chachaEncrypt(key, payload, httpRequestAad('/graphql'))
const response = await httpRequest(url, {
  method: 'POST', headers: { 'c-id': clientId }, body: requestBody
})
if (!response.ok) throw new Error(String(response.status))
const bytes = new Uint8Array(await response.arrayBuffer())
const result = JSON.parse(decryptGraphqlResponse(key, requestBody, bytes))
// Feature error codes are carried in extensions.code; message is diagnostic text.
if (result.errors?.length) throw GqlError.fromGraphql(result.errors[0])

HTTP 401: அங்கீகரிக்கப்பட்ட அமர்வு இல்லை அல்லது செல்லாது. சேமித்த விசை ரத்து செய்யப்படும் வரை அல்லது மாற்றப்படும் வரை, மறுதொடக்கத்திற்குப் பிறகும் செல்லும். 400: requestId தவறான வடிவில் உள்ளது, காலாவதியானது அல்லது மீண்டும் வந்துள்ளது. 429: மீளனுப்பல் தடுப்புத் தற்காலிகச் சேமிப்பு நிரம்பியுள்ளது.