Koppla SMOC med REST API

Enkel guide som visar hur du ansluter till SMOC REST API från din egen kod, synkroniseringsjobb eller CRM-pipelines. Kundnycklar är företagsspecifika och är som standard skrivskyddade. Nycklar med skrivbehörighet kan göra begränsade skrivningar, inklusive att skicka till inkorgen; de kan inte redigera flödesgrafer, publicera flöden eller starta LinkedIn-outreachkampanjer. Superanvändarnycklar kan spara utkast till flöden och teman på samma POST /api/v2/{toolName}-anrop; publicering kräver fortfarande en person i Studio eller Console. Domänverktyg finns på REST v2 som POST /api/v2/{toolName} (samma hanterare som MCP). Fullständig anropslista: REST v2 API-referens. GET /api/company/mongocontact gäller för Zapier.

Hämta din API-nyckel

1. Gå till Inställningar → Integrationer → API i SMOC Console.
2. Ge eventuellt nyckeln ett namn och ett utgångsdatum (7, 30 eller 90 dagar). Lämna utgångsdatum på Ingen utgång om du inte vill att den ska gå ut.
3. Generera nyckeln och kopiera den direkt — den visas bara en gång, så spara den på ett säkert ställe.

Din nyckel är kopplad till ditt företag. Varje begäran som görs med den är automatiskt avgränsad till dina data. Att generera en ny nyckel återkallar inte befintliga nycklar. Utfärdade nycklar listas på samma sida — återkalla oanvända nycklar där. MCP-sidan använder samma kontroller — se skärmdumpen i MCP-guiden.

Bas-URL

Bas-URL: https://api.smoc.ai

Fullständig kontakt-endpoint:

GET https://api.smoc.ai/api/company/mongocontact

Autentisering

Legacy-kontakter: skicka nyckeln i en anpassad HTTP-header med namnet token. REST v2 accepterar Authorization: Bearer eller token.

GET /api/company/mongocontact HTTP/1.1
Host: api.smoc.ai
token: YOUR_SMOC_API_KEY

Använd inte Clerk-hemliga nycklar (sk_…) eller publicerbara nycklar (pk_…).

Vilka funktioner finns

REST v2 — POST /api/v2/{toolName}

Speglas mot MCP-domänverktyg (contacts_search, cpcs_overview, inbox_threads_list och övriga). OpenAPI: GET /api/v2 eller GET /api/v2/openapi.json. Se REST v2-referensen.

Lista företagskontakter — GET /api/company/mongocontact (Zapier / kompatibel)

Returnerar en sida med kontakter för företaget på nyckeln, samt aggregerade räkningar.

Vad den returnerar

• Kontaktposter: namn, e-post, telefon, status, adress, senaste konversationsdatum, besöks-/UTM-historik, enkätsvar, anpassade textfält, hänvisnings- och kampanjdata när det samlats in. Positiva meddelandeflödes-leads är standardleads (status: "1") och inkluderar även leadSentiment, leadCapturedAt och tags om de finns.
• leadsCount — kontakter med status lead (inklusive ej satt)
• customerCount — kontakter med status kund

Räkningarna omfattar alla företagskontakter, inte bara den aktuella sidan.

Query-parametrar

Parameter	Standard	Beskrivning
limit	100	Max antal kontakter att returnera (1–500)
sortByField	(ingen)	Sortera fallande efter createdAt, updatedAt, lastConversationDate eller leadCapturedAt
status	(ingen)	Filtrera efter kontaktstatus. status=1 är standard lead-enkäten och inkluderar positiva meddelandeflödes-leads

Kontaktstatusvärden: "1" lead, "2" kund, "3" förlorad, "4" konverterad.

Kundnycklar kan inte skapa, uppdatera eller ta bort kontakter. Det finns ingen cursor-paginering på mongocontact — använd limit och spåra sedda ID:n på klientsidan, eller använd Zapier polling. Rikare sökning är POST /api/v2/contacts_search.

Fältnivå-svar finns i Public Contacts API-referensen.

Exempelbegäran

curl -s \
  -H "token: YOUR_SMOC_API_KEY" \
  "https://api.smoc.ai/api/company/mongocontact?status=1&limit=25&sortByField=leadCapturedAt"

Vad som inte finns på kund-API:et

Nycklar med skrivbehörighet kan fortfarande inte publicera ett flöde, slå på live (flowcharts_set_active), ta bort poster eller starta en LinkedIn-outreachkampanj. Inkorgs-skicka är valbart på en skrivbar nyckel (inbox_threads_send, endast text, kräver idempotencyKey). Använd SMOC MCP från Claude, Cursor eller VS Code för samma verktyg över MCP.

Säkerhetsnoteringar

• Nyckeln visas endast en gång vid skapande — spara den i en lösenordshanterare eller miljövariabel.
• Lägg aldrig in nyckeln i ett Git-repository.
• Kundnycklar är begränsade till ditt företags data. Standardnycklar är skrivskyddade; skrivningar inklusive inkorgsskicka är valbara.
• Återkalla oanvända nycklar från listan över utfärdade nycklar under Inställningar → Integrationer → API.

Felsökning

• 401 Saknad token-header: skicka token: <key>, inte Authorization: Bearer.
• 401 Ogiltig eller återkallad token: kontrollera att nyckeln är korrekt och inte har återkallats.
• 422 limit får inte överstiga 500: sänk limit query-parametern.
• 422 Ogiltigt statusvärde: använd 1, 2, 3 eller 4.

Se även

• REST v2 API-referens — alla POST /api/v2/{toolName}-anrop
• Ansluta SMOC med REST API
• Public Contacts API
• MCP för Claude, Cursor och VS Code