SMOC REST v2 API-viite

REST v2 on yritystietojen julkinen HTTP-rajapinta. Jokainen domain-työkalu käyttää samaa JSON-runkoa kuin vastaava MCP-työkalu. Asiakasavaimet ovat oletuksena vain luku ja rajattu yritykseesi. Kirjoitusoikeudelliset avaimet voivat kutsua alla olevia rajoitettuja kirjoitustyökaluja. GET /api/company/mongocontact pysyy muuttumattomana Zapierille.

Perus-URL

https://api.smoc.ai

Koneellisesti luettava luettelo: GET /api/v2 tai GET /api/v2/openapi.json.

Tunnistautuminen

Lähetä avain kohdasta Asetukset → Integraatiot → API (tai MCP) muodossa Authorization: Bearer <key> tai vanhassa token-otsikossa.

curl -s -X POST https://api.smoc.ai/api/v2/whoami \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Älä käytä Clerk sk_…- tai pk_…-avaimia.

Muoto

POST /api/v2/{toolName} ja Content-Type: application/json.

Onnistunut vastaus on HTTP 200 ja JSON-objekti. Virheet ovat 4xx ja { "code", "error", "details?" }. Yleisiä koodeja: MISSING_BEARER_TOKEN, INVALID_INPUT, TOOL_DENIED, FLOWCHART_NOT_FOUND.

Asiakasavaimet eivät lähetä companyId:tä. Avain valitsee jo yrityksen.

GET|POST /api/v2/whoami on RESTissä. Löytötyökalut mcp_capabilities, skills_search ja skills_get pysyvät vain MCP:ssä (https://api.smoc.ai/mcp).

Identiteetti

GET|POST /api/v2/whoami

Palauttaa roolin, yritysrajan, oikeudet, tunnisteen tyypin ja ympäristön. Rungon lähettäminen on valinnaista.

Yritys

Kutsu	Runkotiedot	Palauttaa
POST /api/v2/companies_get	{}	Yritysprofiili (otsikko, avain, URL, kielet, asetukset)
POST /api/v2/company_assets_get	{}	Tuotteet, positiointi, verkkosivulinkit, tiedostot
POST /api/v2/settings_notifications_get	{}	Ilmoitusasetusten yhteenveto (ei sähköpostiosoitteita)

Yrityksen omaisuuserien poiminnat

Oikeus: company:read tai cpcs:read.

Kutsu	Runkotiedot	Palauttaa
POST /api/v2/company_asset_extraction_results_list	limit? (1–100), includeData?, statuses?, templateNameKey?, tag?	Poimintojen yhteenveto
POST /api/v2/company_asset_extraction_results_get	resultId (pakollinen), includeData?	Yksi tulos
POST /api/v2/company_asset_extraction_templates_list	limit?, templateNameKey?, tag?	Malli / tunniste / tuoreusyhteenvedot

Kontaktit

Oikeus: contacts:read.

Kutsu	Runkotiedot	Palauttaa
POST /api/v2/contacts_search	Alla olevat suodattimet sekä page?, pageSize? (1–100), sortBy?, sortDirection? (asc | desc)	Sivutetut kontaktit
POST /api/v2/contacts_get	contactId (pakollinen)	Yksi puhdistettu kontakti
POST /api/v2/contacts_get_stats	Samat suodattimet kuin haussa (ei sivutusta)	Lukumäärät ja sitoutumisyhteenveto
POST /api/v2/contacts_get_filter_options	Samat suodattimet sekä optionLimit? (1–200)	Kelvolliset suodatinarvot
POST /api/v2/contact_tags_list	{}	Kontaktitunnisteet
POST /api/v2/prospect_lists_list	{}	Prospektilistat
POST /api/v2/prospect_lists_get	listId (pakollinen)	Yksi prospektilista

Kontaktisuodattimet (kaikki valinnaisia): dateFrom, dateTo (YYYY-MM-DD), search (max 200), location, flow, surveyQuestionAnswer, promosRedeemed, profileInfo, device, os, browser, utmSource, utmMedium, utmCampaign (merkkijono tai taulukko max 50), surveyLanguage, firstName, lastName, msisdn, company, city, street, zip, brandId, status.

sortBy: createdAt, updatedAt, lastConversationDate, email, firstName, lastName, company, city, status.

curl -s -X POST https://api.smoc.ai/api/v2/contacts_search \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"search":"ada","pageSize":20,"sortBy":"updatedAt","sortDirection":"desc"}'

Zapier / yhteensopivuuskontaktit pysyvät GET /api/company/mongocontact ja token-otsikolla. Kenttäkohtaiset mongocontact-muodot: Julkinen kontaktirajapinta.

Saapuneet ja keskustelut

Oikeus: inbox:read lukuihin. Kirjoitusoikeudelliset avaimet tarvitsevat myös inbox:write triaasiin ja tekstin lähettämiseen.

Kutsu	Runkotiedot	Palauttaa
POST /api/v2/inbox_threads_list	q?, sender?, flowId?, contactId?, companyUserId?, conversationId?, inboxFolder? (inbox | archived | all), unreadOnly?, unansweredOnly?, page?, limit? (1–50)	Keskusteluketjut
POST /api/v2/inbox_threads_get	threadId (pakollinen), includeMessages?	Yksi ketju
POST /api/v2/inbox_messages_list	threadId (pakollinen), limit? (1–200)	Viestit, mukaan lukien yhdistetyt rinnakkaisketjut
POST /api/v2/conversations_list	flowId?, contactId?, conversationId?, q?, page?, limit? (1–50)	Viestivirran suoritukset
POST /api/v2/conversations_get	conversationId (pakollinen)	Yksi suoritus, mukaan lukien virstanpylväät
POST /api/v2/inbox_threads_archive	threadId	Arkistoi ketjun
POST /api/v2/inbox_threads_unread	threadId	Merkitsee ketjun lukemattomaksi
POST /api/v2/inbox_threads_mark_handled	threadId	Merkitsee vastaamattomat käsitellyiksi
POST /api/v2/inbox_threads_send	threadId, body, idempotencyKey	Lähettää vain tekstivastauksen

curl -s -X POST https://api.smoc.ai/api/v2/inbox_threads_list \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"unansweredOnly":true,"limit":25}'

Outreach

Kutsu	Oikeus	Runkotiedot	Palauttaa
POST /api/v2/outreach_accounts_list	inbox:read	{}	LinkedIn / outreach-tilin tila
POST /api/v2/outreach_contacts_import_get	contacts:read	importJobId (pakollinen)	Kontaktien tuonti-/rikastusprosessin tila

Vuokaaviot ja Studio

Oikeus: flowcharts:read. Käytä uniqueFlowchartId:ää flowcharts_list:stä flowchartId:na, kun luettelonumero puuttuu.

Kutsu	Runkotiedot	Palauttaa
POST /api/v2/flowcharts_list	name?, operatorKey?, conversationTemplateKey?, status? (draft | published), page?, limit? (1–100)	Vuokaavioiden yhteenvedot
POST /api/v2/flowcharts_get	flowchartId (pakollinen), detail? (summary | full)	Yksi vuokaavio (full sisältää graafin)
POST /api/v2/flowchart_recommendations_list	flowchartId (pakollinen)	Suositusdokumentit
POST /api/v2/flowcharts_versions_list	flowchartId (pakollinen)	Versiotunnisteet, päivämäärät, tila
POST /api/v2/themes_get	operatorKey?	Yrityksen (tai operaattoriavaimen) teema
POST /api/v2/message_flow_settings_get	flowchartId (pakollinen)	Viestivirran / keskustelumallin asetukset
POST /api/v2/message_flow_settings_summary	flowchartId (pakollinen)	Kanavatunniste, kieli, aktiivinen lippu
POST /api/v2/message_flow_contacts_list	flowchartId (pakollinen)	Viimeisimmät keskustelu- / kontaktirivit
POST /api/v2/message_flow_kpis_get	flowchartId (pakollinen)	Keskustelujen kokonaismäärät
POST /api/v2/targeting_portfolios_list	flowchartId (pakollinen)	Kohdennusportfoliot
POST /api/v2/targeting_portfolios_get	portfolioId (pakollinen)	Yksi portfolio
POST /api/v2/studio_generations_get	jobId (pakollinen; generationId myös hyväksytään)	Generointitehtävä
POST /api/v2/studio_translations_get	jobId (pakollinen; translationId myös hyväksytään)	Käännöstehtävä
POST /api/v2/studio_generation_categories_list	executionFlowType? (web | message)	Generointikategoriat kyseiselle virratyypille

Superkäyttäjäavaimilla, joilla on vuokaavioiden kirjoitusoikeus, voi myös muokata Mongo-luonnoksia. Nämä kutsut eivät julkaise, vaihda live-tilaa tai lisää ensimmäistä erää. Julkaisu pysyy painikkeena Studiossa tai Consolessa.

Kutsu	Runkotiedot	Palauttaa
POST /api/v2/flowcharts_create	name, flowType? (web | message), webFormat? (chat | card)	Uusi luonnostunniste
POST /api/v2/flowcharts_duplicate	flowchartId, name?	Kopioi uutena luonnoksena
POST /api/v2/flowcharts_save	flowchartId, flowchart, expectedRevision?	Tallennettu luonnosversio
POST /api/v2/flowcharts_restore_version	flowchartId, versionId	Palautettu luonnos
POST /api/v2/themes_save	operatorKey, operatorChannelKey, theme	Teemaluonnoksen versio
POST /api/v2/flowchart_recommendation_item_update	docId, index, status (applied | rejected)	Päivitetty kohde
POST /api/v2/targeting_portfolio_update	portfolioId, patch (status?, provider?, dimensions?)	Päivitetty portfolio

flowcharts_save hyväksyy flowType web tai message, channel ja webFormat chat tai card graafimetatiedoissa. Verkkovirrat käyttävät kanavaa chat. Viestivirrat käyttävät linkedin, email tai whatsapp. Tallennus säilyttää tallennetun aktiivisen lipun.

curl -s -X POST https://api.smoc.ai/api/v2/flowchart_recommendations_list \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"flowchartId":"YOUR_UNIQUE_FLOWCHART_ID"}'

Analytiikka

Oikeus: analytics:read. Päivämäärät ovat YYYY-MM-DD. Yhteiset valinnaiset suodattimet: startDate, endDate, flowId, flowVersionId, deviceType, os, country, languageCode, utmSource, utmMedium, utmCampaign.

Kutsu	Lisärunko	Palauttaa
POST /api/v2/analytics_flow_list_flows	Yhteiset suodattimet	Virrat liikennemäärän mukaan
POST /api/v2/analytics_flow_kpis	Yhteiset suodattimet	Kokonaismäärät ja edellisen jakson erot
POST /api/v2/analytics_flow_timeseries	Yhteiset suodattimet, granularity? (day | month)	Päivittäinen tai kuukausittainen sarja
POST /api/v2/analytics_flow_dimension_metrics	Yhteiset suodattimet, dimension (pakollinen), limit? (1–200)	Erottelu
POST /api/v2/analytics_flow_filter_values	Yhteiset suodattimet	Kelvolliset suodatinarvot
POST /api/v2/edge_visit_counts_get	conversationTemplateId (pakollinen), startDate?, endDate?	Reunavierailujen määrät

dimension:n on oltava yksi seuraavista: deviceType, os, country, languageCode, utmSource, utmMedium, utmCampaign, dayOfWeek.

curl -s -X POST https://api.smoc.ai/api/v2/analytics_flow_kpis \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startDate":"2026-08-01","endDate":"2026-08-31"}'

Verkkosivuston skannaus (CPCS)

Oikeus: cpcs:read.

Kutsu	Runkotiedot	Palauttaa
POST /api/v2/cpcs_overview	{}	Projekti-, indeksointi-, poiminta- ja aikatauluyhteenvedot
POST /api/v2/cpcs_urls_list	{}	Verkkosivu-/linkki-URL-osoitteet, joita käytetään indeksoinnissa
POST /api/v2/cpcs_crawls_get	crawlId (pakollinen), projectId?	Yksi indeksointitehtävä
POST /api/v2/cpcs_extractions_get	extractionId (pakollinen), projectId?	Yksi poimintatehtävä
POST /api/v2/cpcs_list_templates	{}	Poimintamallit
POST /api/v2/cpcs_schedule_get	{}	Indeksointiaikataulu

Kirjoitukset (valinnainen)

Oletusavaimet pysyvät vain luku -tilassa. Kun valitset Salli rajoitetut kirjoitukset Consolessa, avain voi kutsua kontaktien/tunnisteiden/listojen luonti-päivitystä, yritysprofiilin / omaisuuserien perustietoja, cpcs_urls_add, vuokaavion nimeämistä / suositustilaa, saapuneiden triaasia ja inbox_threads_send.

Mitä asiakasavaimet eivät voi tehdä

Kirjoitusoikeudelliset asiakasavaimet eivät edelleenkään voi poistaa tietoja, muokata virragrafiikkaa, julkaista virtoja, vaihtaa live-tilaa, muuttaa kohdennusta, käynnistää krediittejä kuluttavia tehtäviä tai lähettää LinkedIn-outreach-kampanjoita. Superkäyttäjäavaimet voivat tallentaa virta- ja teemaluonnoksia sekä päivittää kohdennusulottuvuuksia MCP:ssä ja REST v2:ssa; ne eivät silti voi julkaista. GET /api/company/mongocontact pysyy Zapier/yhteensopivuuskontaktien sopimuksena.

MCP

Samat työkalut ovat käytettävissä Claude-, Cursor- ja VS Code -integraatioissa osoitteessa https://api.smoc.ai/mcp. Ohjeet: MCP eGuide. Yhdistämisen opas: REST-yhteysopas.

Katso myös

• SMOCin yhdistäminen REST-rajapintaan
• Julkinen kontaktirajapinta
• MCP Claude-, Cursor- ja VS Code -käyttöön
• Kerätyn asiakastiedon integrointi