Medal Social SDK er en typet, lettvekts TypeScript-klient designet for å forenkle interaksjoner med Medal Social API. I stedet for å manuelt konstruere HTTP-forespørsler og håndtere autentiseringsheadere, kan utviklere bruke et robust, metodebasert grensesnitt for å integrere sosiale og CRM-funksjoner i applikasjonene sine.
Hvorfor bruke SDK?
Å integrere direkte med REST API-er kan være feilutsatt, og krever boilerplate-kode for fetch-operasjoner, feilhåndtering og typedefinisjoner. Medal Social SDK løser disse utfordringene ved å tilby:
- Full typesikkerhet: Skrevet i TypeScript, gir den autofullføring og kompileringstidskontroll for alle forespørselsdata.Forenklet autentisering: Støtter både Basic (Client ID/Secret) og Bearer token-autentisering rett ut av boksen.Bekvemmelighetsmetoder: Dedikerte metoder for vanlige handlinger som å opprette leads, notater og hendelser.
Installasjon og oppsett
Kom i gang ved å installere pakken via din foretrukne pakkebehandler:
pnpm add @medalsocial/sdkInitialiser klienten med legitimasjonen din. Du kan bruke miljøvariabler for å holde hemmeligheter trygge.
import MedalSocialClient from '@medalsocial/sdk';
const client = new MedalSocialClient({
auth: {
kind: 'basic',
clientId: process.env.MEDAL_CLIENT_ID!,
clientSecret: process.env.MEDAL_CLIENT_SECRET!
},
// Alternatively use a bearer token
// auth: { kind: 'bearer', token: process.env.MEDAL_API_TOKEN! },
});Nøkkelfunksjoner og bruksområder
1. Lead-generering
Fang interesse fra markedsføringssiden eller landingssidene dine direkte inn i CRM-systemet ditt. createLead-metoden aksepterer en array, noe som muliggjør masseoppretting.
await client.createLead([
{
name: 'Alex Example',
email: 'lead.test@example.com',
company: 'Tech Corp',
source: 'website-landing-page',
},
]);2. Kundekontekst (notater)
Berik brukerprofiler med kontekst ved å bruke createNote. Dette er perfekt for salgsteam som trenger å logge interaksjoner eller supportteam som registrerer brukerdetaljer.
await client.createNote({
name: 'Test Testnes',
email: 'test@medalsocial.com',
company: 'Medal Social Test company',
content: 'Customer is interested in the enterprise plan. Follow up next week.',
metadata: { Budget: '$100,000', Urgency: 'High' },
});3. Hendelsesstyring
Registrer brukere sømløst for webinarer, produktlanseringer eller konferanser ved å bruke createEventSignup. Det kobler kontaktdetaljene med spesifikke hendelsesmetadata.
await client.createEventSignup({
contact: {
name: 'Test Testnes',
email: 'test@medalsocial.com',
company: 'Medal Social Test company',
},
event: {
externalId: 'launch-2025',
name: 'Product Launch 2025',
description: 'Unveiling our latest tools',
time: '2025-06-15T14:00:00Z',
location: 'Online Stream',
},
});4. Compliance og personvern
Administrer brukersamtykke og sikre GDPR/CCPA-compliance ved å registrere cookie-preferanser via createCookieConsent.
await client.createCookieConsent({
domain: 'example.com',
consentStatus: 'partial',
consentTimestamp: new Date().toISOString(),
ipAddress: '192.168.1.1',
userAgent: 'Mozilla/5.0...',
cookiePreferences: {
necessary: { allowed: true },
marketing: { allowed: false },
analytics: { allowed: true }
},
});