API viide

Looge kohandatud integratsioonid Asyntai REST API-ga

Hangi API võti

Nõutav tasuline pakett: API juurdepääs on saadaval Starter, Standard ja Pro pakettidel. Vaata hindu

Ülevaade

Asyntai API võimaldab teil integreerida AI-põhise klienditoe mis tahes rakendusse. Saatke sõnumeid ja saage intelligentseid vastuseid, mis on treenitud teie veebisaidi sisu ja teadmistebaasi põhjal.

Autentimine

Kõik API päringud vajavad autentimist teie API võtme abil. Saate oma API võtme API sätete lehelt.

Kaasake oma API võti päringutesse, kasutades ühte järgmistest meetoditest:

  • Autoriseerimise päis (soovitatav): Authorization: Bearer YOUR_API_KEY
  • X-API-Key päis: X-API-Key: YOUR_API_KEY

Hoidke oma API võti saladuses. Igaüks, kellel on teie võti, pääseb teie kontole ligi API kaudu. Ärge kunagi paljastage seda kliendipoolses koodis.

Baas-URL

https://asyntai.com/api/v1/

Lõpp-punktid

POST /chat/

Saatke sõnum ja saage AI loodud vastus.

Päringu keha

{
  "message": "What are your business hours?",
  "session_id": "user_123",      // optional
  "website_id": 1                 // optional
}
Parameeter Tüüp Nõutav Kirjeldus
message string Jah Kasutaja sõnum, mis saadetakse AI-le
session_id string Ei Vestluse unikaalne identifikaator. Kasutage sama session_id-d vestluse ajaloo säilitamiseks.
website_id integer Ei Konkreetne veebisaidi ID. Kui seda ei esitata, kasutatakse teie peamist veebisaiti.

Vastus

{
  "success": true,
  "response": "Our business hours are Monday-Friday, 9 AM to 5 PM EST.",
  "session_id": "user_123"
}

Näide (cURL)

curl -X POST https://asyntai.com/api/v1/chat/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "What are your business hours?", "session_id": "user_123"}'

Näide (Python)

import requests

response = requests.post(
    "https://asyntai.com/api/v1/chat/",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "message": "What are your business hours?",
        "session_id": "user_123"
    }
)

data = response.json()
print(data["response"])

Näide (JavaScript)

const response = await fetch("https://asyntai.com/api/v1/chat/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    message: "What are your business hours?",
    session_id: "user_123"
  })
});

const data = await response.json();
console.log(data.response);

GET /websites/

Loetlege kõik teie kontoga seotud veebisaidid.

Vastus

{
  "success": true,
  "websites": [
    {
      "id": 1,
      "name": "My Website",
      "domain": "example.com",
      "is_primary": true
    }
  ]
}

Näide (cURL)

curl https://asyntai.com/api/v1/websites/ \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /conversations/

Hankige konkreetse seansi vestlusajalugu.

Päringu parameetrid

Parameeter Tüüp Nõutav Kirjeldus
session_id string Jah Seansi ID, mille ajalugu hankida
limit integer Ei Tagastatavate sõnumite maksimum (vaikimisi: 50, maks: 100)

Vastus

{
  "success": true,
  "session_id": "user_123",
  "messages": [
    {
      "role": "user",
      "content": "What are your business hours?",
      "timestamp": "2024-01-15T10:30:00Z"
    },
    {
      "role": "assistant",
      "content": "Our business hours are Monday-Friday, 9 AM to 5 PM EST.",
      "timestamp": "2024-01-15T10:30:01Z"
    }
  ]
}

Näide (cURL)

curl "https://asyntai.com/api/v1/conversations/?session_id=user_123&limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /sessions/

Loetlege oma hiljutised vestlussessioonid. Kasutage seda sessioonide ID-de leidmiseks, mille saate edastada /conversations/ lõpp-punktile täieliku sõnumite ajaloo saamiseks.

Päringu parameetrid

Parameeter Tüüp Nõutav Kirjeldus
limit integer Ei Tagastatavate hiljutiste seansside arv (vaikimisi: 20, maks: 100)
website_id string Ei Filtreerige sessioone konkreetse veebisaidi ID järgi
source string Ei Filtreerige seansi allika järgi: widget, api, whatsapp, instagram, messenger, gorgias, freshchat, zapier

Vastus

{
  "success": true,
  "sessions": [
    {
      "session_id": "session_abc123def",
      "source": "widget",
      "message_count": 5,
      "first_message": "What are your business hours?",
      "first_message_at": "2024-01-15T10:30:00Z",
      "last_message_at": "2024-01-15T10:35:00Z",
      "website_domain": "example.com"
    }
  ]
}

Näide (cURL)

curl "https://asyntai.com/api/v1/sessions/?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /leads/

Kogutud müügivihjete toomine — e-posti aadressid ja telefoninumbrid, mille külastajad vestluste käigus esitasid.

Päringu parameetrid

Parameeter Tüüp Nõutav Kirjeldus
limit integer Ei Tagastatavate müügivihjete arv (vaikimisi: 50, maks: 100)
website_id string Ei Filtreerige müügivihjeid konkreetse veebisaidi ID järgi

Vastus

{
  "success": true,
  "leads": [
    {
      "session_id": "session_abc123def",
      "email": "visitor@example.com",
      "phone": "+1234567890",
      "page_url": "https://example.com/pricing",
      "started_at": "2024-01-15T10:30:00Z"
    }
  ]
}
Väli Tüüp Kirjeldus
session_id string Vestlusseansi ID. Edastage see /conversations/-le, et näha täielikku vestlusajalugu.
email string või null Külastaja esitatud e-posti aadress, või null kui ei kogutud
phone string või null Külastaja esitatud telefoninumber, või null kui ei kogutud
page_url string või null Lehe URL, kus külastaja vestles
started_at string ISO 8601 ajatempel vestlusseansi alguse kohta

Näide (cURL)

curl "https://asyntai.com/api/v1/leads/?limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

Näide (Python)

import requests

response = requests.get(
    "https://asyntai.com/api/v1/leads/",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"limit": 20}
)

leads = response.json()["leads"]
for lead in leads:
    print(f"{lead['email'] or ''} | {lead['phone'] or ''}")

GET /account/

Hankige oma konto andmed ja kasutusstatistika.

Vastus

{
  "success": true,
  "account": {
    "email": "you@example.com",
    "plan": "starter",
    "messages_used": 150,
    "messages_limit": 2500
  }
}

Näide (cURL)

curl https://asyntai.com/api/v1/account/ \
  -H "Authorization: Bearer YOUR_API_KEY"

Mitu veebisaiti? Teadmistebaasi lõpp-punktid kasutavad vaikimisi teie põhiveebisaiti. Kui teil on mitu veebisaiti, edastage website_id konkreetse sihtimiseks. Leiate oma veebisaidi ID-d, kasutades GET /websites/.

Igapäevased üleslaadimispiirangud: Teadmistebaasi üleslaadimised (tekst, URL, arvutustabel) on piiratud igapäevase tähemärkide limiidiga vastavalt teie paketile. See kehtib kogu sisu kohta, mis laaditakse üles kõigi teadmistebaasi lõpp-punktide kaudu päevas.

Pakett Tähemärke/päevas
Starter100 000
Standard500 000
Pro2 000 000

GET /knowledge/

Loetlege oma teadmistebaasi kirjed. Need on sisuallikad, mida teie AI vestlusrobot kasutab küsimustele vastamiseks.

Päringu parameetrid

Parameeter Tüüp Nõutav Kirjeldus
limit integer Ei Tagastatavate kirjete arv (vaikimisi: 50, maks: 100)
website_id string Ei Filtreerige veebisaidi ID järgi (vaikimisi teie põhiveebisait)

Vastus

{
  "success": true,
  "entries": [
    {
      "id": "abc-123-def",
      "type": "text",
      "title": "Business Hours",
      "description": "Manual text content (150 words)",
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "ghi-456-jkl",
      "type": "url",
      "title": "About Us - Example",
      "description": "Content from https://example.com/about",
      "created_at": "2024-01-14T09:00:00Z"
    }
  ]
}

Näide (cURL)

curl "https://asyntai.com/api/v1/knowledge/?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /knowledge/text/

Lisage kohandatud tekstisisu oma teadmistebaasi. AI kasutab seda külastajate küsimustele vastamiseks.

Päringu keha

{
  "title": "Return Policy",
  "content": "We offer a 30-day return policy on all items. Items must be unused and in original packaging. Refunds are processed within 5-7 business days.",
  "website_id": "123"
}
Parameeter Tüüp Nõutav Kirjeldus
title string Jah Selle teadmuskirje pealkiri
content string Jah Tekstisisu (vähemalt 10 tähemärki)
website_id string Ei Sihtveebisait (vaikimisi teie põhiveebisait)

Vastus

{
  "success": true,
  "id": "abc-123-def",
  "title": "Return Policy",
  "chunks_created": 1
}

Näide (cURL)

curl -X POST "https://asyntai.com/api/v1/knowledge/text/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Return Policy", "content": "We offer a 30-day return policy..."}'

POST /knowledge/url/

Lisage veebileht oma teadmistebaasi. Sisu toomitakse ja eraldatakse automaatselt.

Päringu keha

{
  "url": "https://example.com/faq",
  "website_id": "123"
}
Parameeter Tüüp Nõutav Kirjeldus
url string Jah URL, kust sisu tuua
website_id string Ei Sihtveebisait (vaikimisi teie põhiveebisait)

Vastus

{
  "success": true,
  "id": "abc-123-def",
  "title": "FAQ - Example",
  "url": "https://example.com/faq",
  "chunks_created": 5
}

Näide (cURL)

curl -X POST "https://asyntai.com/api/v1/knowledge/url/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/faq"}'

POST /knowledge/spreadsheet/

Laadige CSV või Exceli (.xlsx) arvutustabel oma teadmistebaasi. Iga rida saab eraldi teadmistebaasi kirjeks, ideaalne tootekataloogide, KKK loendite, hinnatabelite ja kataloogide jaoks.

Päring

Saatke kui multipart/form-data (faili üleslaadimine), mitte JSON.

Parameeter Tüüp Nõutav Kirjeldus
file fail Jah .csv või .xlsx fail. Esimene rida peab olema veergude päised. Maksimaalne ridade arv üleslaadimise kohta: Starter 500, Standard 2000, Pro 10 000. Üleliigsed read kärbitakse.
website_id string Ei Sihtveebisait (vaikimisi teie põhiveebisait)

Vastus

{
  "success": true,
  "id": "abc-123-def",
  "title": "products.csv",
  "rows_processed": 15,
  "chunks_created": 15
}

Näide (cURL)

curl -X POST "https://asyntai.com/api/v1/knowledge/spreadsheet/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@products.csv"

DELETE /knowledge/{id}/

Kustutage teadmistebaasi kirje. id on leitav GET /knowledge/ vastusest.

Vastus

{
  "success": true,
  "message": "Knowledge base entry deleted"
}

Näide (cURL)

curl -X DELETE "https://asyntai.com/api/v1/knowledge/abc-123-def/" \
  -H "Authorization: Bearer YOUR_API_KEY"

Vihje: Veebikonkse saate hallata ka API sätted lehelt ilma koodi kirjutamata.

GET /webhooks/

Loetlege oma registreeritud veebihaagid.

Vastus

{
  "success": true,
  "webhooks": [
    {
      "id": "abc-123-def",
      "url": "https://example.com/webhook",
      "events": ["message.received", "escalation.requested"],
      "is_active": true,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Näide (cURL)

curl "https://asyntai.com/api/v1/webhooks/" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /webhooks/

Registreerige uus veebihaak reaalajas sündmuste teavituste saamiseks.

Saadaolevad sündmused

Sündmus Kirjeldus
message.received Külastaja saatis sõnumi ja sai vastuse
conversation.started Alustati uut vestlusseanssi
escalation.requested AI käivitas eskaleerimise inimesest agendile
takeover.started Inimesest agent võttis vestlussessiooni üle

Päringu keha

{
  "url": "https://example.com/webhook",
  "events": ["message.received", "escalation.requested"],
  "website_id": "123"
}
Parameeter Tüüp Nõutav Kirjeldus
url string Jah HTTPS URL veebihaagi POST päringute vastuvõtmiseks
events massiiv Jah Tellimisel olevate sündmuste loend (vt ülaltoodud tabelit)
website_id string Ei Sihtveebisait (vaikimisi teie põhiveebisait)

Vastus

{
  "success": true,
  "webhook": {
    "id": "abc-123-def",
    "url": "https://example.com/webhook",
    "events": ["message.received", "escalation.requested"],
    "secret": "whsec_abc123...",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Veebihaakide kontrollimine: Iga veebihaak sisaldab secret (näidatakse ainult loomisel). Iga POST teie URL-ile sisaldab X-Webhook-Signature päis — päringu keha HMAC-SHA256, mis on allkirjastatud teie salavõtmega.

Näide (cURL)

curl -X POST "https://asyntai.com/api/v1/webhooks/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/webhook", "events": ["message.received"]}'

DELETE /webhooks/{id}/

Kustutage veebihaak. id on leitav GET /webhooks/ vastusest.

Vastus

{
  "success": true,
  "message": "Webhook deleted"
}

Näide (cURL)

curl -X DELETE "https://asyntai.com/api/v1/webhooks/abc-123-def/" \
  -H "Authorization: Bearer YOUR_API_KEY"

Veavastused

Kõik veavastused järgivad seda vormingut:

{
  "success": false,
  "error": "Error message describing what went wrong"
}
Olekukood Kirjeldus
400 Vigane päring - Sobimatud parameetrid või puuduvad kohustuslikud väljad
401 Volitamata - Sobimatu või puuduv API võti
429 Liiga palju päringuid - Teie paketi sõnumite limiit on täitunud
503 Teenus pole saadaval - AI teenus on ajutiselt kättesaamatu

Päringupiirangud

API kasutust piirab teie tellimispakett:

  • Tasuta: 100 sõnumit/kuus
  • Starter (39 $/kuus): 2500 sõnumit/kuus
  • Standard (139 $/kuus): 15 000 sõnumit/kuus
  • Pro (449 $/kuus): 50 000 sõnumit/kuus

Vajate abi?

Kui teil on küsimusi või tekib probleeme, võtke meiega ühendust aadressil hello@asyntai.com.