API viide

Integreerige enuchat oma süsteemidesse, kasutades Tenant API-d. Hallake vestlusi, saatke sõnumeid ja pääsege arveldusandmetele juurde programselt.

Autentimine

Kõik API päringud autentitakse X-Api-Key päises saadetava API võtme abil.

Oma API võtme saamine

  1. Minge juhtpaneelil Seaded → API võtmed
  2. Klõpsake Loo API võti ja andke sellele nimi
  3. Kopeerige võti kohe — seda näidatakse ainult üks kord
  4. Säilitage see turvaliselt (keskkonnamuutuja, saladuste haldur)

Päringute tegemine

Lisage võti igasse päringusse:

curl -H "X-Api-Key: tak_your_key_here" \
     https://api.enuchat.com/api/v1/tenant-api/widgets

Kõik vastused on JSON. Edukatel vastustel on data väli. Vigadel on error väli koos code ja message-iga.

Turvalisus: API võtmed räsitakse (SHA-256) meie andmebaasis. Me ei salvesta kunagi töötlemata võtit. Käsitlege oma võtit nagu parooli — ärge kaasake seda koodi ega jagage avalikult.

Baas-URL

https://api.enuchat.com/api/v1/tenant-api

Kõik alltoodud lõpp-punktid on suhtelised selle baas-URL-i suhtes.

Lõpp-punktid

GET /widgets

Loend kõigist teie konto vidinatest.

Vastus

{'{'}
  "data": [
{'{'}
      "id": "019d19c6-7e0b-...",
      "name": "Main Website Chat",
      "isActive": true,
      "aiEnabled": true,
      "translationEnabled": true,
      "primaryColor": "#2563eb",
      "position": "bottom-right"
    }
  ]
}

GET /conversations

Loend vestlusi, järjestatud viimase sõnumi järgi.

Päringu parameetrid

ParameeterTüüpKirjeldus
statusstringFiltreeri oleku järgi: open, pending, closed
widgetIdstringFiltreeri vidina UUID järgi
limitintegerMaksimaalne tulemusi (vaikimisi 20, maks 100)
offsetintegerJäta N tulemust vahele

Näide

curl -H "X-Api-Key: tak_..." \
     "https://api.enuchat.com/api/v1/tenant-api/conversations?status=open&limit=10"

Vastus

{'{'}
  "data": [
{'{'}
      "id": "019d6724-000e-...",
      "widgetId": "019d19c6-7e0b-...",
      "visitorId": "v-abc123",
      "visitorName": "John",
      "visitorEmail": "john{'@'}example.com",
      "visitorLanguage": "en",
      "status": "open",
      "assignedTo": null,
      "lastMessageAt": "2026-04-11T14:30:00+00:00",
      "startedAt": "2026-04-11T14:25:00+00:00"
    }
  ]
}

GET /conversations/{'{'}id}

Hankige vestlus kõigi sõnumitega.

Päringu parameetrid

ParameeterTüüpKirjeldus
limitintegerMaksimaalne sõnumeid (vaikimisi 50, maks 200)

Vastus

{'{'}
  "data": {'{'}
    "id": "019d6724-000e-...",
    "visitorLanguage": "en",
    "status": "open",
    "messages": [
{'{'}
        "id": "019d6724-1234-...",
        "role": "visitor",
        "content": "Hello, how much does it cost?",
        "contentLanguage": "en",
        "translatedContent": "Cześć, ile to kosztuje?",
        "translatedLanguage": "pl",
        "isAutoReply": false,
        "createdAt": "2026-04-11T14:25:30+00:00"
      },
{'{'}
        "id": "019d6724-5678-...",
        "role": "ai",
        "content": "Our plans start at €19/month...",
        "isAutoReply": true,
        "createdAt": "2026-04-11T14:25:32+00:00"
      }
    ]
  }
}

POST /conversations/{'{'}id}/messages

Saatke vestlusesse sõnum. Sõnum toimetatakse külastajale reaalajas vestlusvidina kaudu.

Päringu keha

{'{'}
  "content": "Thanks for reaching out! We'll process your request.",
  "role": "system"
}
VäliTüüpKirjeldus
contentstringNõutav. Sõnumi tekst.
rolestringsystem (vaikimisi) või operator

Vastus (201 Created)

{'{'}
  "data": {'{'}
    "id": "019d6725-abcd-...",
    "role": "system",
    "content": "Thanks for reaching out!",
    "createdAt": "2026-04-11T14:35:00+00:00"
  }
}

PATCH /conversations/{'{'}id}

Värskendage vestluse olekut või määramist.

Päringu keha

{'{'}
  "status": "closed"
}
VäliTüüpKirjeldus
statusstringopen, pending või closed
assignedTostring|nullOperaatori UUID määramiseks või null määramise tühistamiseks

GET /billing/balance

Hankige oma praegune plaan ja krediidi saldo.

Vastus

{'{'}
  "data": {'{'}
    "plan": "pro",
    "creditBalance": 4500000,
    "totalCreditsAdded": 10000000
  }
}

Vigade käsitlemine

Vead tagastavad mitte-2xx olekukoodi JSON-kehaga:

{'{'}
  "error": {'{'}
    "code": "NOT_FOUND",
    "message": "Conversation not found."
  }
}
HTTP olekTähendus
401Kehtetu, aegunud või puuduv API võti
400Kehtetu päringu keha või parameetrid
404Ressurssi ei leitud (või kuulub teisele rentnikule)
500Serveri viga

Tavalised kasutusjuhud

CRM integratsioon

Küsige uusi vestlusi ja sünkroniseerige külastaja andmed (nimi, e-post, keel) oma CRM-iga. Kasutage vestluse ID-d välise viidena.

Automatiseeritud järelmeetmed

Pärast vestluse sulgemist saatke API kaudu järelsõnum: „Aitäh vestluse eest! Kas on veel midagi, millega saame aidata?"

Webhook alternatiiv

Kuni väljuvad webhookid on saadaval, küsige vestluste lõpp-punkti perioodiliselt, et tuvastada uusi sõnumeid või oleku muutusi.

Massitoimingud

Sulgege kõik üle 7 päeva vanad vestlused, määrake vestlused operaatoritele välise loogika põhjal või eksportige vestluste ajalugu analüütika jaoks.

Kiiruse piirangud

API lubab kuni 60 päringut minutis API võtme kohta. Kui ületate selle piirangu, saate 429 Too Many Requests vastuse. Oodake ja proovige uuesti eksponentsiaalse tagasilangusega.

Valmis integreerima?

Looge oma tasuta konto ja genereerige minutitega API võti.

Alusta tasuta