Skip to content

apiDocsTitle

apiDocsSubtitle

apiDocsOverviewTitle

apiDocsOverviewText

apiDocsBaseUrl: https://nexontech.org/api/widget

apiDocsQuickStartTitle

apiDocsQuickStartText

1. apiDocsQuickStep1

POST /api/widget/init
Content-Type: application/json

{
  "key": "wk_your_widget_key"
}

2. apiDocsQuickStep2

POST /api/widget/chat
Content-Type: application/json

{
  "key": "wk_your_widget_key",
  "conversation_id": "conv_id_from_step_1",
  "text": "Hello, I need help!"
}

apiDocsAuthTitle

apiDocsAuthText

apiDocsAuthWhereKey

  1. apiDocsAuthStep1
  2. apiDocsAuthStep2
  3. apiDocsAuthStep3

apiDocsInitTitle

POST/api/widget/init

apiDocsInitDesc

apiDocsRequestBody

apiDocsTableFieldapiDocsTableTypeapiDocsTableRequiredapiDocsTableDescription
keystringYesapiDocsInitKeyDesc
visitor_idstringNoapiDocsInitVisitorDesc
page_urlstringNoapiDocsInitPageDesc

apiDocsResponse 200 OK

{
  "conversation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "visitor_id": "v_abc123",
  "chatbot_name": "Support Bot",
  "config": {}
}
apiDocsTableFieldapiDocsTableTypeapiDocsTableDescription
conversation_idstringapiDocsInitRespConvId
visitor_idstringapiDocsInitRespVisitorId
chatbot_namestringapiDocsInitRespChatbotName
configobjectapiDocsInitRespConfig

apiDocsChatTitle

POST/api/widget/chat

apiDocsChatDesc

apiDocsRequestBody

apiDocsTableFieldapiDocsTableTypeapiDocsTableRequiredapiDocsTableDescription
keystringYesapiDocsChatKeyDesc
conversation_idstringYesapiDocsChatConvDesc
textstringYesapiDocsChatTextDesc
visitor_idstringNoapiDocsChatVisitorDesc
langstringNoapiDocsChatLangDesc

apiDocsResponse 200 OK

{
  "response": "Hi! I'd be happy to help. What can I do for you today?",
  "user_reply_options": ["Check order status", "Talk to a human", "Browse products"]
}
apiDocsTableFieldapiDocsTableTypeapiDocsTableDescription
responsestringapiDocsChatRespResponse
user_reply_optionsstring[]apiDocsChatRespOptions
apiDocsNote: apiDocsChatNoteText

apiDocsRateLimitTitle

apiDocsRateLimitText

apiDocsErrorsTitle

apiDocsErrorsText

apiDocsErrorCodeapiDocsErrorMeaning
400 Bad RequestapiDocsError400
403 ForbiddenapiDocsError403
429 Too Many RequestsapiDocsError429
502 Bad GatewayapiDocsError502
504 Gateway TimeoutapiDocsError504

apiDocsErrorFormat

{
  "error": "Invalid or inactive widget key"
}

apiDocsEmbedTitle

apiDocsEmbedText

<script src="https://nexontech.org/widget.js" data-key="wk_your_widget_key"></script>

apiDocsEmbedNote