> ## Knowledge Base Index > Fetch the complete knowledge base index at: https://support.haddock.app/sitemap.xml > Use this file to discover available pages before exploring further. > Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash). # Agora Connector ✨ New and recommended > ⭐ **Recommended method for connecting Agora to haddock** haddock Connector is a small program that is installed on your restaurant computer and automatically sends sales from Agora to haddock. Once configured, it runs by itself and you do not have to do anything else. [📄 Download full PDF guide](https://storage.googleapis.com/haddock-connector/haddock-connector-latest-install-guide-agora.pdf) --- ## What do I need before starting? * The computer where Agora is installed must be **turned on and running Agora**. * You need **access to that computer** to install the program. If you are not physically at the venue, you can ask someone there to give you remote access with **AnyDesk** or **TeamViewer** - these are free programs that let you see and control the computer from another location. * Have the **Agora API Token** handy: it does not exist out of the box, it is the key you define when enabling the integration module in the **"Before installing - set up Agora"** section (usually done by your Agora reseller). * And the **haddock authentication code** (you will find it in the haddock web app, under Restaurant settings > My integrations > Agora Connector). > 💡 **Tip:** If you do not have all the details or do not feel confident doing the installation, the easiest option is to **send everything to your Agora reseller or IT technician**. Share the [PDF guide](https://storage.googleapis.com/haddock-connector/haddock-connector-latest-install-guide-agora.pdf) and the haddock authentication code with them - they will be able to do the installation and setup remotely without you having to handle anything technical. --- ## Before installing - set up Agora The connector reads sales through Agora's **integration HTTP API**. Before installing it, that module has to be enabled and the key the connector will use (the **API Token**) defined. You need **Agora 6.0.6 or later** and an **Agora license that includes the Integration Services module** (*Módulo de Servicios de Integración*) - your reseller enables it. > ✅ **If something is already set up, do not change it:** write down the value and move on to the next step. Steps **B** and **C** are look-ups only, they change nothing in Agora. ### A - Enable the module and get the API Token 1. In the **Agora Monitor** (the server, not the POS), open **Herramientas > Activar Módulos Adicionales**. ![Agora's Activar Módulos Adicionales window](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/pos-setup-01-agora-activate-additional-modules-window.png) 2. Check the **Activar Módulo de Servicios de Integración** box in the left-hand column. ![Close-up of the Activar Módulo de Servicios de Integración checkbox](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/pos-setup-02-agora-integration-services-module-checkbox.png) 3. Click **Configurar Servicios de Integración** right below it, enable the **integration HTTP API**, and enter a **key**. It can be any value, but use a **long, unique key**: it grants access to the POS sales. **Write it down, because that key is the API Token** from Step 2. 4. Press **Aceptar** to save. That API uses port **8984** by default, the same one the connector already has under *Connection settings*. > ⚠️ **If the box cannot be checked**, your license does not include the module: ask your Agora reseller to enable it. Without it, the connector will fail on the *API license active* check. > **Already done?** If the box is already checked and the HTTP API already has a key, **copy that key as it is** (it is your API Token) and move on to step B. Do not change it: if another integration uses it, you would break it. ### B - Get the Location Id (Workplace ID) - only with ACMS > In the connector, this value goes in the **Workplace IDs** field. Only needed if you have **ACMS** (Agora Central Management System), that is, a central installation managing several locations; it makes the connector pull only this restaurant's sales. **With a single location, leave the "Workplace IDs" field empty** — you will find it under **Link a restaurant** during initial setup; if the restaurant is already linked, go to **Connections**, select the restaurant, and click **Edit configuration** — and move on to step C. In the **Agora web administration**, go to **Administración > Locales**: the **Id** column is the value you need (in the example, "La Macarena" has **Id 1**). If one haddock restaurant collects sales from several locations, enter them separated by commas: `1, 2`. ![Locales list in the Agora administration with the Id column](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/pos-setup-03-agora-admin-locales-id-column.png) ### C - Get the POS Id (Punto de Venta) - only if you split POS terminals Only needed if a single location has **several POS terminals** and you want each one to go to a **different haddock restaurant** (for example, a bar and a terrace invoiced separately). In any other case - the most common one - skip this step: haddock will collect the sales of every terminal in the location. In the **Agora web administration**, go to **Administración > Puntos de Venta**: the **Id** column of each terminal is the value you need. The **Local** column tells you which location it belongs to, and **Tipo** whether it is a POS, an order-taking handheld, a tablet, and so on. For several, separate them with commas: `1006, 1009`. ![Puntos de Venta list in the Agora administration with the Id column](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/pos-setup-04-agora-admin-points-of-sale-id-column.png) > ⚠️ **Do not confuse Puntos de Venta with Grupos de Puntos de Venta:** the groups only filter reports inside Agora and are **not valid** here. > 💡 The connector only filters by location (Workplace ID), it **has no POS Id field**. If you need to split the terminals of one location, write these Ids down and contact haddock support chat. --- ## Step 1 - Download and install 1. On the computer where Agora is installed, download the haddock Connector installer from **[bit.ly/haddockconnector](https://bit.ly/haddockconnector)**. 2. Open the downloaded file. If Windows asks for permission (Windows protection screen), click **"More info"** and then **"Run anyway"**. ![Windows Defender warning](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/01-windows-defender-smartscreen-warning.png) ![Run anyway](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/02-windows-defender-smartscreen-run-anyway.png) 3. Follow the installer steps: * Welcome screen: ![Installer welcome](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/03-haddock-connector-installer-welcome-screen.png) * Select the destination folder: ![Destination folder](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/04-haddock-connector-installer-select-destination-folder.png) * Make sure the **"Create a desktop shortcut"** option is checked. ![Additional tasks](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/05-haddock-connector-installer-select-additional-tasks-desktop-shortcut.png) * Review the summary and click **"Install"**. ![Ready to install](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/06-haddock-connector-installer-progress.png) 4. When installation finishes, make sure **"Launch haddock Connector"** is checked and click **"Finish"**. The program will open automatically. ![Finish installation](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/07-haddock-connector-installer-finish-and-launch-application.png) --- ## Step 2 - Configuration When you open haddock Connector, you will complete two screens: first connect Agora, then link your haddock restaurant. **1. Connect your POS** * On the **Which POS do you use?** screen, select **Agora**. * In **API Token**, enter the integration HTTP API key you obtained in step **A** of "Before installing - set up Agora". * If you need to change the port, expand **Connection settings**. The default is **8984**. * Click **Continue**. ![Agora selection and API Token on the Connect your POS screen](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/08-haddock-connector-app-connect-agora.png) **2. Link a restaurant** * **Restaurant name (optional):** enter a name to identify it in the Connector. * **Authentication Code:** go to haddock and open **Restaurant settings > My integrations > Agora Connector**. Copy the 10-character code shown there and paste it here. * **Workplace IDs:** enter the Agora location ID described in step **B**. If you have a single location, leave it empty. To include several locations in this restaurant, separate their IDs with commas: `1, 2`. ![Linking a restaurant with its authentication code and Workplace IDs](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/09-haddock-connector-app-link-restaurant.png) **3. Import and sync preferences** You can keep the defaults or expand this section to change them: * **Sales history to import:** defaults to **Last 180 days**. You can also select **Last year** or **Choose dates**. * **Sync interval:** defaults to **30 minutes**. --- ## Step 3 - Connect Click **Connect restaurant**. The Connector will check the connection to Agora, the API Token, the integration license, and the connection to haddock. It will also check the authentication code and any **Workplace IDs** you entered. If everything is correct, your configuration will be saved and you will reach the **Connections** screen, where you can follow the sales sync. If there is a problem, the Connector will highlight the field you need to correct or show a message explaining the issue. See the **Errors and solutions** section of this guide. --- ## How do I know it is working? On the **Connections** screen, you will see your linked restaurants, their status, and when each one was **last synced**. During the first import, you will see **"Importing your sales history"** along with its progress. This can take a while if there is a lot of history. ![Connections screen while importing sales history](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/10-haddock-connector-app-importing-sales-history.png) When the sync finishes successfully, the restaurant will show **"Up to date"** and its last sync time will be updated. ![Restaurant up to date with its last sync time and the Sync Now button](https://storage.googleapis.com/helpdesk-haddock-images/integrations/point-of-sale/agora-connector-new-and-recommended/images/11-haddock-connector-app-up-to-date.png) --- ## Day-to-day use * The program **runs in the background** - you do not need to keep it open. When you close the window, it minimizes to the notification area (bottom right of the Windows desktop) and keeps working. * To open it again, **click the icon** in the notification area. * It updates and restarts itself if there is any problem - you do not need to worry about anything. --- ## 🔧 Errors and solutions If there is a problem when connecting, the Connector will highlight the field you need to correct or show a message explaining the issue. Look it up here to see what to do: ### 🚨 "API not accessible on localhost:8984. Make sure Agora is running on this machine." ✅ Agora is not open, is on another computer, the port is wrong, or a firewall/antivirus is blocking the port. Check that: * Agora is **open and running on this same computer**. * The port under *Connection settings* is **8984** (the default). * If opening **http://localhost:8984** in the browser on this machine loads nothing, Agora's API is not listening there: contact your Agora reseller. ### 🚨 "Agora server is reachable but the API Token was rejected." ✅ The API Token is wrong or inactive. Ask your Agora reseller for the correct token and to confirm it is active. ### 🚨 "Integration module is not activated in Agora (501)." ✅ The token is valid, but the module is not activated on this installation. Review step **A** of the "Before installing - set up Agora" section: the **Activar Módulo de Servicios de Integración** box must be checked and the **integration HTTP API** enabled. If it cannot be checked, your license does not include the module: contact your reseller. ### 🚨 "Cannot reach haddock cloud." ✅ The computer has no internet access, or a firewall/proxy/antivirus is blocking the secure (HTTPS) connection to haddock. Check the computer's internet connection and that the firewall or antivirus allows outbound HTTPS traffic to haddock. If the message says the cloud "is reachable but rejected the request", it is a temporary issue: try again in a few minutes. ### 🚨 "Authentication code is invalid" / "Invalid authentication code format." ✅ The code was copied incorrectly or has expired. Go to the haddock web app (**Restaurant settings** > **My integrations** > **Agora Connector**), generate a new one, and paste it in full. Codes expire if they are not used. ### 🚨 I do not have the Agora API Token ✅ It is Agora's **integration HTTP API key**: you will find it (or create it) under **Herramientas > Activar Módulos Adicionales > Configurar Servicios de Integración** - steps in the **"Before installing - set up Agora"** section. If you do not have access to the Agora Monitor, ask your reseller for it. ### 🚨 The sync finishes, but I do not see sales ✅ Check that you are viewing the correct restaurant and dates in haddock, that Agora has sales for that period, and that those dates are included in the history you imported. Also check the **Workplace IDs** field: it determines which Agora location the sales come from. To review it, go to **Connections**, select the restaurant, and click **Edit configuration**. * **If you have a single location:** leave the **Workplace IDs** field empty to receive sales from all its POS terminals. * **If you have multiple locations with ACMS:** check that the IDs correspond to the location you want to link. You will find them under **Administración > Locales**, in the **Id** column (step **B** of "Before installing - set up Agora"). The Connector rejects non-numeric values such as `WP1` or `test` and, when it can retrieve Agora's locations, IDs that do not exist or are inactive. However, a valid ID may belong to another location: passing validation does not guarantee you selected the right restaurant. If the Connector cannot verify the locations, it will show a warning. After correcting the details, click **Save configuration**. When no history import or sync is running, you can click **Sync Now** under **Connections**. During initial setup, the button used to link the restaurant is **Connect restaurant**. --- ## The connector was working and now it fails * **I do not see sales right after connecting:** the first import can take a while if there is a lot of history. Check its progress under **Connections** and wait for it to finish. The **Sync Now** button is not shown during the import. * If you see **"Sync is temporarily delayed"**, the Connector will try again automatically. Click **View details** to see the problem and review the **Errors and solutions** section of this guide. * The connector also shows **notifications in the Windows notification area** (bottom right) when it has been unable to reach the POS or haddock for a while. * Check that the POS computer is **powered on** and that Agora is still running. Still not working after checking this? See **[How to fix connection problems with my POS](https://support.haddock.app/en/article/how-to-fix-connection-problems-with-my-pos-oasu2t/)** or contact haddock support chat. *Integrations may include additional costs not covered by haddock.*