City Remit AI Integration Guide

Learn how to integrate the City Remit AI chatbot into your website. This guide covers everything from basic setup to advanced customization options.

Prerequisites

  • Valid API key from City Remit
  • Website with HTML access
  • Basic understanding of HTML and JavaScript

Quick Start

Add the following script to your HTML page just before the closing </body> tag:


                <script>
                (function () {
                    var d = document.createElement('div');
                    d.id = 'chat-bot';
                    document.body.appendChild(d);
                    
                    var s = document.createElement("script");
                    s.async = true;
                    s.src = "https://jp.cityremit.global/web-api/customer-support/chat-widget/YOUR_API_KEY";
                    s.crossOrigin = "anonymous";
                    s.onload = () => window.ChatWidget?.init("YOUR_API_KEY");
                    document.head.appendChild(s);
                })();
          </script>
Note: Replace YOUR_API_KEY with your actual City Remit API key in both places.

Installation

Step 1: Get Your API Key

Contact City Remit support to obtain your unique API key.

Step 2: Add the Base HTML


          <!DOCTYPE html>
          <html lang="en">
          <head>
              <meta charset="UTF-8" />
              <title>Your Website</title>
          </head>
          <body>
              <!-- Existing Body Content -->
              <!-- Chat widget script will be added here -->
          </body>
          </html>

Troubleshooting

Common Issues

  • Widget not appearing: Check if your API key is correct and properly inserted in both places.
  • Script loading errors: Ensure your website has access to the City Remit domain.
Need Help? Contact City Remit support for assistance with integration issues.