Pe API

Ndaipóri endpoint ñemombykyva. Interfaz peguarãnte avei ndaipóri.

Hetave producto oguereko mokõi API: pe oñemombe'u porãva oñeme'ẽva, ha pe oiporúva pe pantalla kuéra. Pe mokõiha iporãvéva, ha nderepukaséi peve. Ko'ápe peteĩnte oĩ, ha pe interfaz ha'e peteĩ cliente chugui ambue mba'eicha — kóva peteĩ restricción orekópe, ha pe arakatu re'apoitegua ikatu haguére.

Mba'e pe regla katuete omba'apo

He'ise peteĩ pantalla sapy'ánte oha'arã API oiko porã haguére, ndaha'éi ojapo peteĩ campo iporãva'anga. Pe ára peteĩ pantalla oikotevẽ mba'e pe API pública ndome'ẽiva ha'e pe ára pe API vaíva, ha pe solución ha'e pe API.

Pe ventaja ha'e mbohapy cliente oikoitegua omba'apo'ỹve. Pe MCP server ha'e peteĩ cliente. Petеĩ dash-b tile ha'e peteĩ cliente. Ne script ha'e peteĩ cliente. Ndaipóri peteĩva clase mokõiha ojapo peteĩ superficie ambue tapicha peguarã, ndaipóri rupi ambue superficie.

Oñemombe'u, ha ojapóva

OpenAPI ojapo /docs peve ha opaite ruta oguereko peteĩ test ha'e pe ejemplo pe documento pegua. Documentación ohaiva'ekue código pegua oñembyai peteĩ arýpe; documentación ojapo vaíva pe build ojapo vaíva ndojapói.

Eñeirũ

Nde castomo cuenta, authorization code flow PKCE ndive — pe cuenta peteĩva eipuru dash-b ha pe familia ambue peguarã. Petеĩ kuatia servidor'ỹva ojapo porã pe flow; ha'e pe ojapóva pe flow. Máquina-máquina remba'apópe, petеĩ API key proyecto peguarã.

Pe superficieapi.clicksomo.com

1Tapicha/v1/contacts · /lists · /segments · /tags · /imports
2Jehaipyre/v1/creatives, validación, preview ha render peteĩteĩ target peguarã
3Jeikoehegui/v1/funnels · /funnels/:id/versions · /runs · /simulate
4Ñemyasãi/v1/campaigns, audiencia, materialise, schedule ha send peteĩteĩ paso ramo
5Oúva evento/v1/events — ne aplicación evento, trigger ramo
6Entrega/sender-identities · /domains · /apps · /webhooks
7Papapy/v1/reports/*, ha /track/* pe tracking host pegua

OpenAPI /docs peve/mcp pe proceso peteĩva pegua

Convención

Pe forma peteĩva castomo servicio opaite pegua

Kóva omba'apove oñe'ẽ hague. Eiporúramo peteĩva ko'ãva, reikuaamáma kóva omba'apo, ojapo vaí ha ojapo paginación.

Peteĩ error envelope

Opaite ojapo vaí oguereko pe forma peteĩva, petеĩ código oikóva ha petеĩ ñe'ẽ tapicha peguarã. Ndaipóri ruta ojapo isã mba'eichagua.

Cursor paginación

Ndaipóri offset. Petеĩ lista oñemoambuéva ereko aja ndojapói ndoheja térã ndojerere fila, pe offset paginación ojapo sa'i ha opa ára.

Idempotencia ñemongaruati

Oimeraẽ tape omoambuéva'eképe mba'épe. Eha'arõ jey peteĩ jerure nde reikuaa'ỹva ohasápa ha epehengatu pe ñembohovái peteĩha, peteĩha mba'e'apo, peteĩha ñemondo.

Peteĩ proyecto-pe oñemohenda

Peteĩ token oheka peteĩ inquilino ha peteĩ proyecto, mokõive. Seguridad fila-ñembyatyrã ojejapo base de datos pype, ndaha'éi eakatupyrãvo emoĩ hag̃ua peteĩ cláusula.

Webhooks esépe

Oñemonguatia, ojeyjey backoff ndive, ha oñemondo peteĩ jey peve — upévare nde endpoint oikova'erã idempotente. Umi evento ha'e pe ñe'ẽjoapy reports oiporúva.

Ñemboguete ha ñeguenohẽ

Peteĩ contacto ikatu oñeguenohẽ térã oñemboguete API rupive, ha peteĩ ñemboguete oguahẽ opaite ambue servicio oiporúva pe copia, familia mba'e tape ryepýpe.

Oimeraẽ mba'e interfaz ikatúva, peteĩ POST ikatu.

Evento ha'e pe ovy'apýva

Oimeraẽ ambue mba'e ko kuatiaroguépe ha'e tubería reikotevẽva. POST /v1/events ha'e pe tape omoambuéva mba'épa pe producto rehegua.

Nde aplicación oikuaa jey mba'e araka'eve peteĩ herramienta marketing ikatu'ỹva ohecha: mávapa ombopuku onboarding, mávapa ohenói peteĩ compañero, mávapa ojopy peteĩ límite, mávapa oñeguenohẽ hembiaporã peteĩ domingo arakõpe. Ehai umíva evento ramo nde token ndive, ha peteĩteĩva oiko peteĩ disparador, peteĩ condición ha peteĩ segmento.

Ambue mba'e oúta contacto modelo guive. Evento oñembojoapy, araka'eve ndoñemoambuéi; ha'e pe registro opaite producto oñeha'ãva. Peteĩ funnel oñepyrũva peteĩ evento nde reiporaváre ndaha'éi peteĩ integración — ha'e pe mecanismo message_opened oiporúva, ambue téra ndive.

Nde evento oiko peteĩ funnelapi_event

1Ehai chupePOST /v1/events — peteĩ téra, peteĩ contacto, peteĩ payload, peteĩ idempotencia clave.
2OguahẽOñembojoapy contacto registro-pe. Ambue mba'eve ndaipóri oikuaa hag̃ua oikópa.
3Peteĩ funnel oñepyrũOimeraẽ funnel ijehaipysóva ohero pe evento, oimeraẽ contacto oĩva ijehaipysópe.
4Ambue funnel oñemohenda chugui"Ko evento ojehúpa 14 ára pukukue jave" ha'e peteĩ segmento condición común.
iHa omboty tembiapoPeteĩ meta nodo ohero pe evento omboty peteĩ secuencia ojapovópe pe persona pe mba'e.

Nde ñe'ẽjoapyNde token

Límite oikuaa va'erã emoheñói mboyve

ClickSomo oñongatu mbohapy identificador nde rehegua — peteĩ inquilino, peteĩ proyecto ha peteĩ usuario, ids opacúva ramo — ha ambue mba'eve. Ndaipóri contraseña, ndaipóri perfil, ndaipóri tarjeta, ndaipóri factura. Plan límite oúta papapy ramo: mbohapýpa contacto, mbohapýpa ñemondo, mbohapýpa generación. Pagar ñe'ẽjoapy ndoikuaái pe línea mokõive ládo guive.

Nde contacto nde mba'e. Nde ha'e pe data controlador; ñande ha'e pe procesador. Ndaipóri tape ambue producto familia pegua ikatúva omoñe'ẽ térã ohai nde contacto lista, ha ndaipóri ingest tape oiporúva hag̃ua.

Ere'óramo ehechakuaa porãitépe: emoñe'ẽ /docs emoñe'ẽ mboyve ambue mba'e ko sitio web pegua. API ha'e pe ñe'ẽpy ojoapy'ỹva mba'épa pe producto ojapo, ha oimeraẽ ñe'ẽ ko kuatiaroguépe oĩ peteĩ tape térã nodo tipo upépe ejuhukuaa. Esquema oñemoambuévo, ko kuatiarogue oñemoambuete.