Gorgias Connector

Poveži svojo pomoč za stranke Gorgias z Brevo za marketinško angažiranje na osnovi podpore, marketinške tokove po zaključku zahtevka in enotno analitiko izkušnje strank prek Tajo.

Pregled

LastnostVrednost
PlatformaGorgias
KategorijaSupport
Zahtevnost nastavitveEnostavna
Uradna integracijaNe
Sinhronizirani podatkiStranke, zahtevki, dogodki
Vrsta APIREST API
AvtentikacijaAPI Key + Email (Basic Auth)
Osnovni URLhttps://{domain}.gorgias.com/api/

Funkcionalnosti

  • Sinhronizacija dogodkov zahtevkov – posreduj dogodke ustvarjanja, reševanja in CSAT zahtevkov v časovnice Brevo
  • Obogatitev profilov strank – sinhroniziraj podatke strank Gorgias, vključno z oznakami in polji po meri, v Brevo
  • Kampanje po podpori – sproži delovne tokove Brevo po reševanju zahtevka za nadaljnje ukrepanje ali upsell
  • Sledenje zadovoljstvu – sinhroniziraj rezultate anket CSAT kot atribute stikov Brevo
  • Segmentacija na osnovi oznak – zrcali oznake strank Gorgias kot članstva v seznamih Brevo
  • Dogodki makrov in pravil – sledi samodejnim dejanjem za operativno analitiko

Predpogoji

Preden začneš, se prepričaj, da imaš:

  1. Račun Gorgias z dostopom administratorja
  2. Poddomeno Gorgias (npr. yourstore.gorgias.com)
  3. API ključ in povezan e-mailni naslov
  4. Brevo račun z dostopom do API
  5. Tajo račun z aktivno naročnino

Avtentikacija

Gorgias za avtentikacijo uporablja HTTP Basic Auth z e-mailnim naslovom računa in API ključem.

Ustvarjanje API ključa

  1. Prijavi se v nadzorno ploščo Gorgias
  2. Pojdi na Settings > REST API
  3. Klikni Create API Key (ali kopiraj obstoječi ključ)
  4. Zabeleži si osnovni URL API: https://{domain}.gorgias.com/api/
Terminal window
# Basic Auth: email as username, API key as password
curl -X GET "https://yourstore.gorgias.com/api/customers" \
-u "[email protected]:$GORGIAS_API_KEY" \
-H "Content-Type: application/json"

Dovoljenja API ključa

API ključi Gorgias imajo popoln dostop do podatkov tvojega računa. Ni modela dovoljenj na osnovi obsegov. Zaščiti API ključ in ga redno menjaj.

Povezovanje s Tajo

Terminal window
tajo connectors install gorgias \
--domain yourstore.gorgias.com \
--api-key $GORGIAS_API_KEY

Konfiguracija

Osnovna nastavitev

connectors:
gorgias:
enabled: true
domain: "yourstore.gorgias.com"
sync:
customers: true
tickets: true
satisfaction_surveys: true
tags: true
lists:
all_support_contacts: 35
satisfied_customers: 36
dissatisfied_customers: 37

Preslikava polj

Preslikaj polja strank in zahtevkov Gorgias v atribute stikov Brevo:

field_mapping:
# Customer fields
id: GORGIAS_ID
email: email
name: FIRSTNAME
phone: SMS
# Support metrics
nb_tickets: TICKET_COUNT
last_ticket_date: LAST_SUPPORT_DATE
last_ticket_channel: LAST_SUPPORT_CHANNEL
avg_response_time: AVG_RESPONSE_TIME
# CSAT data
last_satisfaction_score: CSAT_SCORE
satisfaction_count: CSAT_RESPONSES
# Custom fields
customer_type: CUSTOMER_TYPE
vip_status: VIP_STATUS

Preslikava dogodkov

event_mapping:
ticket.created: SUPPORT_TICKET_OPENED
ticket.closed: SUPPORT_TICKET_RESOLVED
ticket.reopened: SUPPORT_TICKET_REOPENED
satisfaction_survey.created: CSAT_SURVEY_SENT
satisfaction_survey.responded: CSAT_SUBMITTED
customer.created: SUPPORT_CUSTOMER_CREATED

Končne točke API

Tajo se integrira z naslednjimi REST API končnimi točkami Gorgias:

Končna točkaMetodaNamen
/api/customersGETSeznam strank
/api/customers/{id}GETPridobi stranko
/api/customersPOSTUstvarjanje stranke
/api/customers/{id}PUTPosodobi stranko
/api/ticketsGETSeznam zahtevkov
/api/tickets/{id}GETPridobi zahtevek
/api/tickets/{id}/messagesGETSeznam sporočil zahtevka
/api/tagsGETSeznam oznak
/api/satisfaction-surveysGETSeznam anket CSAT
/api/satisfaction-surveys/{id}GETPridobi anketo
/api/usersGETSeznam agentov
/api/integrationsGETSeznam integracij
/api/eventsGETSeznam dogodkov
/api/customers/{id}/custom-fieldsGETPridobi vrednosti polj po meri

Primeri kode

Inicializacija konektorja

import { TajoClient } from '@tajo/sdk';
const tajo = new TajoClient({
apiKey: process.env.TAJO_API_KEY,
brevoApiKey: process.env.BREVO_API_KEY
});
await tajo.connectors.connect('gorgias', {
domain: 'yourstore.gorgias.com',
apiKey: process.env.GORGIAS_API_KEY
});

Sinhronizacija strank v Brevo

await tajo.connectors.sync('gorgias', {
type: 'incremental',
resources: ['customers'],
since: '2024-01-01',
batchSize: 30
});
const status = await tajo.connectors.status('gorgias');
console.log(status);
// {
// connected: true,
// lastSync: '2024-03-15T17:00:00Z',
// customersCount: 14200,
// ticketsTracked: 28600,
// csatResponses: 3400
// }

Obravnava dogodkov zahtevkov prek HTTP integracije

// Gorgias can send HTTP requests via Rules or HTTP integrations
app.post('/webhooks/gorgias', async (req, res) => {
const event = req.body;
await tajo.connectors.handleEvent('gorgias', {
type: 'ticket.updated',
payload: {
ticketId: event.ticket_id,
status: event.status,
customerEmail: event.customer?.email,
channel: event.channel,
tags: event.tags,
satisfaction: event.satisfaction
}
});
res.status(200).send('OK');
});

Kampanja po reševanju

// Trigger a follow-up email after a support ticket is resolved
tajo.connectors.on('gorgias', 'ticket.closed', async (event) => {
if (event.satisfaction_score >= 4) {
await tajo.campaigns.trigger('post-support-upsell', {
email: event.customer.email,
params: {
agent_name: event.assignee.name,
ticket_subject: event.subject,
resolution_time: event.resolution_time
}
});
}
});

Sinhronizacija podatkov CSAT

// Sync satisfaction survey results to Brevo attributes
await tajo.connectors.sync('gorgias', {
type: 'incremental',
resources: ['satisfaction_surveys'],
since: '2024-01-01'
});

Omejitve hitrosti

Gorgias uveljavlja omejitve hitrosti na račun:

Vrsta omejitveVrednost
Omejitev hitrosti API2 zahtevka na sekundo
Dovolitev sunkovDo 5 zahtevkov v kratkih sunkih
Paginacija30 elementov na stran (privzeto), največ 100

Strategija paginacije

Gorgias uporablja paginacijo na osnovi kazalca s parametroma cursor in limit. Tajo to obravnava samodejno, zahteva do 100 elementov na stran za maksimalno učinkovitost.

Gorgias vrne 429 Too Many Requests, ko so presežene omejitve hitrosti.

Odpravljanje težav

Pogoste težave

TežavaVzrokRešitev
401 UnauthorizedNeveljaven e-mail ali API ključPreveri poverilnice v Gorgias Settings > REST API
404 Not FoundNeveljavna končna točka ali ID viraPreveri, ali osnovni URL API vsebuje tvojo poddomeno
Manjkajoče strankeNi e-maila v zapisuGorgias za ujemanje strank zahteva e-mail
Oznake se ne sinhronizirajoOznake niso dodeljene strankamPreveri, ali so oznake na objektih strank, ne samo zahtevkov
Počasna sinhronizacijaNizka omejitev hitrostiGorgias omejuje na 2 zahtevka/s; polne sinhronizacije trajajo dlje

Način odpravljanja napak

connectors:
gorgias:
debug: true
log_level: verbose
log_api_calls: true

Preizkus povezave

Terminal window
tajo connectors test gorgias
# ✓ API authentication successful
# ✓ Customer list accessible
# ✓ Ticket data readable
# ✓ CSAT surveys available
# ✓ Tags listable

Najboljše prakse

  1. Za sinhronizacijo v realnem času uporabi HTTP integracije – nastavi pravila Gorgias za pošiljanje HTTP zahtevkov Taju ob dogodkih zahtevkov
  2. Redno sinhroniziraj podatke CSAT – z ocenami zadovoljstva poganjaj kampanje za ponovnega angažiranja
  3. Preslikaj oznake v segmente – prevedi oznake strank Gorgias v članstva v seznamih Brevo
  4. Skrbno obravnavaj paginacijo – z omejitvijo 2 zahtevka/s načrtuj daljše čase sinhronizacije za velike nabore podatkov
  5. Poveži s podatki e-trgovine – združi podatke podpore Gorgias s podatki naročil Shopify v Brevo
  6. Menjaj API ključe – ker imajo ključi Gorgias popoln dostop, jih periodično menjaj

Varnost

  • Basic Auth – e-mail in API ključ prek HTTPS
  • Samo HTTPS – vsa komunikacija API šifrirana prek TLS 1.2+
  • Ključi s popolnim dostopom – brez granularnega obseganja (skrbno zaščiti ključe)
  • Dovoljenje IP – na voljo na višjih planih Gorgias
  • Šifrirano shranjevanje – poverilnice API šifrirane v mirovanju v Tajo
  • Skladnost SOC 2 – platforma Gorgias je certificirana po SOC 2 Type II

Povezani viri

Subscribe to updates

developer-docs

Drop your email or phone number — we'll send you what matters next.

auto-detect
AI pomočnik

Živjo! Vprašajte me o dokumentaciji.