Skip to content
API дар марҳилаи beta аст ва бидуни огоҳии пешакӣ тағйир ёфта метавонад.

Нуқтаҳои ниҳоии даъватномаҳо

Нуқтаҳои ниҳоии даъватнома даъватномаҳои лоиҳаро идора мекунанд. Баъзеашон оммавианд (дидани даъватнома), дигарон тасдиқи ҳувият талаб мекунанд (қабул кардан).

Дидани даъватнома

Гирифтани маълумот дар бораи даъватнома тавассути token-и он. Ин нуқтаи ниҳоии оммавӣ аст — тасдиқи ҳувият лозим нест.

GET /invites/:token

Ҷавоби 200:

json
{
  "id": "invite-uuid",
  "email": "user@example.com",
  "role": "member",
  "project": {
    "name": "My App",
    "slug": "my-app"
  },
  "invitedBy": {
    "displayName": "Project Owner"
  },
  "expiresAt": "2024-01-15T00:00:00.000Z",
  "is_expired": false
}

Хатогиҳо:

ҲолатТавсиф
404Даъватнома ёфт нашуд ё мӯҳлаташ гузашта

Қабули даъватнома

Қабули даъватномаи лоиҳа. Корбари тасдиқшуда бо нақши муайяншуда дар даъватнома ба лоиҳа пайваст мешавад.

POST /invites/:token/accept

Тасдиқи ҳувият: Ҳатмӣ

Ҷавоби 200:

json
{
  "project_slug": "my-app",
  "redirect_url": "https://myapp.com/welcome"
}

Хатогиҳо:

ҲолатРамзТавсиф
400INVITE_EXPIREDМӯҳлати даъватнома гузаштааст
400EMAIL_MISMATCHДаъватнома ба email-и дигар фиристода шуда
400ALREADY_MEMBERАллакай аъзои ин лоиҳа ҳастед
404INVITE_NOT_FOUNDДаъватнома ёфт нашуд

Мувофиқати email

Агар даъватнома ба email-и муайян фиристода шуда бошад, корбари қабулкунанда бояд он email-ро дар ҳисоби HitKey-и худ тасдиқ карда бошад.


Ҷараёни даъватнома

mermaid
sequenceDiagram
    participant A as Admin
    participant API as HitKey API
    participant E as Email
    participant U as Invited User

    A->>API: POST /projects/:slug/invites
    API->>E: Send invite email
    E->>U: Click invite link
    U->>API: GET /invites/:token
    API->>U: Invite details
    U->>API: POST /invites/:token/accept
    API->>U: Joined project

Бақайдгирӣ бо даъватнома

Корбарони нав метавонанд мустақиман тавассути истиноди даъватнома бақайд гиранд:

POST /auth/register/with-invite

Бадани дархост:

json
{
  "invite_token": "INVITE_TOKEN",
  "email": "user@example.com",
  "password": "secure_password"
}

Ҷавоби 200:

json
{
  "token": "hitkey_...",
  "refresh_token": "a1b2c3d4e5f6...",
  "expires_in": 3600,
  "user": {
    "id": "uuid",
    "email": "user@example.com",
    "displayName": "User"
  },
  "project_slug": "my-app",
  "redirect_url": "https://myapp.com/welcome"
}

Ин ҳисоб месозад ва даъватномаро дар як қадам қабул мекунад, ва аз ҷараёни бақайдгирии муқаррарии 3-қадама мегузарад.

HitKey Service License.