Ühenda Tiny Ant oma tööriistadega
REST API, MCP-server ja webhook'id
Kasuta REST API-t müügivõimaluste, kontaktide, ülesannete, pakkumiste ja veebilehe külastusandmete haldamiseks. MCP-server teeb valiku neist toimingutest kättesaadavaks ühilduvatele assistentidele. API-võti saab tööruumi andmeid nii lugeda kui ka muuta, seega ühenda ainult usaldusväärseid tööriistu.
Autentimine
Iga päring sisaldab Authorization-päises tööruumi API-võtit:
Authorization: Bearer ta_live_...Tööruumi haldurid loovad võtmeid rakenduse lehel Seaded (jaotis API ja MCP). Võtit näidatakse loomisel üks kord ja selle saab igal ajal tühistada. Võtme looja rolli muutmine liikmeks tühistab tema võtmed jäädavalt; looja eemaldamine muudab tema võtmed kehtetuks. Hilisem halduriks edutamine vanu võtmeid ei taasta. Võtmeid ei saa kasutada, kui tööruum on peatatud. Võti tegutseb selle loonud halduri nimel: märkmed, ülesanded ja sündmused omistatakse sellele inimesele ning kõik võtmega loodu on nähtav kogu tööruumile. API ja MCP-server sisalduvad pakettides Pro ja Team. Loo ja halda võtmeid vaates Seaded → API ja MCP.
Ilma kehtiva võtmeta päringud saavad vastuseks 401. Free paketiga tööruum saab vastuseks 403.
Baas-URL
https://app.tinyant.io/api/v1Enamik päringute kehasid ja vastuseid kasutab JSON-vormingut (UTF-8). Pakkumiste üleslaadimine kasutab multipart-vormiandmeid, nagu allpool kirjeldatud. ID-d algavad eesliitega de_, co_, pe_, ta_ või no_, millele järgneb 12 märki; pakkumiste ID-d on 12 märki ilma eesliiteta. Ajatemplid on Unixi millisekundites. Allolevad otspunktid kirjeldavad avaldatud integratsiooniliidest. Kui täielikku andmekeha pole siin dokumenteeritud, võta eeskujuks rakenduse võrgupäringud.
Otspunktid
| Meetod | Asukoht | Mida see teeb |
|---|---|---|
| GET POST PUT DELETE | /automations, /automations/:id | CRM Advanced: halduri reeglid ja viimased 100 juurdepääsetavat käivitust. POST/PUT nõuab välju name, definition, eelvaatest saadud confirmation, revision (uue puhul 0) ja mode off|simulate|live. Alusta režiimist simulate; režiim live nõuab muutmata versiooni edukat simulatsiooni. API kaudu loodud reeglid jäävad seotuks oma algse halduri ja võtmega. Vastutaja muutmise toimingud on saadaval ainult rakenduses. DELETE arhiveerib reegli ja tühistab ootel käivitused. |
| POST | /automations/preview | Valideeri {definition}: version:1; päästik deal_created|stage_changed|stalled|proposal_opened; valikuline pipeline_id, stage_id, owner_id; stalled after_days 1..90. Üks toiming: create_task {title,delay_days:0..90,assignee_id}, set_field {field:expected_close,value:YYYY-MM-DD} või notify {assignee_id}. Vastutaja on kehtiv liikme ID või deal_owner. Tagastab kinnituse ja kuni 20 sobivat näidet. Muudatusi ei tehta. |
| POST | /automations/:id/simulate, /automations/:id/stop, /automations/:id/cancel | Lisa järjekorda simulatsioon {deal_id}, peata reegel {} või tühista ootel käivitus {run_id}. Taustal käivitamine kontrollib kehtivaid õigusi uuesti. Muudatused ja kviitungid kinnitatakse koos; korduskatsed ei korda juba kinnitatud toimingut. Väljuvaid e-kirju ei saadeta. |
| GET | /automation-notifications | Praeguse kasutaja sisemine postkast, filtreeritud kehtiva müügivõimaluste juurdepääsu järgi. E-posti ega brauseri tõuketeavitusi ei saadeta. |
| GET PUT | /dashboard | Isiklik töölaud: GET tagastab kaardikataloogi, salvestatud seadistuse ja reaalajas õigustega piiratud mõõdikud; PUT {revision,config} salvestab ainult praeguse kasutaja paigutuse ja filtrid. Seadistuse versioon 1: days 7/30/90, owner all/mine/unassigned, valikuline pipeline_id ja currency ning unikaalsed kaardid {id,size} kataloogist laiustega 4/6/8/12. Prognoos ja tulemused nõuavad Advanced-halduri õigusi; Visitors nõuab tasulist paketti. Andmeid ei salvestata kunagi koos paigutusega. API-võtmed säilitavad oma olemasoleva kirjete ulatuse. |
| GET | /bulk | Praegused liikmed, tegevuste seaded ja sinu 20 viimast hulgipartiid. Hulgitoimingu eelvaade ja edenemine on piiratud selle looja ja sama API-võtmega. |
| POST | /bulk/preview | Vaata 1 kuni 100 valitud ettevõtte, inimese või müügivõimaluse eelvaadet, kasutades välju entity, ids ja action: activity ning tegevuse välju nagu ülesande loomisel. Tagastab valitud nimed, kirjepõhise valideerimise ja kinnituse. Tegevuste loomine kasutab kehtivaid muutmisõigusi ning samu ajastamise, Advanced-tüüpide ja mahukontrolle nagu üksiktegevused. Vastutaja muutmine on saadaval ainult tööruumi rakenduses ja ainult halduritele kooskõlas kirjete juurdepääsu haldusega. |
| GET POST | /bulk/:id | Loe eelvaadet või tulemusi või tee POST-päring kinnitusega, et rakendada korraga atomaarselt kuni viis rida. Korda sama ID-d ja räsi kuni valmimiseni; juba tehtud ridu uuesti ei käivitata. Tulemuste olekud on applied, skipped, failed või pending. CRM-i või juurdepääsuõiguste muudatused muudavad ootel töö kehtetuks. Kontrolli tulemusi ja loo eelvaade ainult allesjäänud kirjetele. Tööruumi kohta hoitakse alles kuni 100 partiid, mis on kättesaadavad seitse päeva ja eemaldatakse seejärel korralise puhastuse või järgmise hulgieelvaatega. Omaniku või tööruumi kustutamine eemaldab ka eelvaated ja kviitungid. E-kirju ega kutseid ei saadeta. |
| GET | /imports/catalog | Väljade ja müügitorude kataloog impordi vastendamiseks. Kõik CRM-i liikmed saavad vaadata eelvaadet ja importida; kohandatud väljade ja lisamüügitorude seadistamine nõuab endiselt CRM Advancedit. |
| POST | /imports/preview | Vaata 1 kuni 100 rea (kuni 500 KB) eelvaadet parameetritega kind ja duplicates: fill või skip. Toetab objekti custom_fields püsiva ID järgi, müügitoru ja etapi ID-sid või üheseid nimesid ning otseseid kirjete ID-sid. Režiim fill täidab ainult tühjad väärtused; olemasoleva müügivõimaluse summa, olek ja etapp ei muutu. Korduvad kirjed jäetakse vahele. Eelvaate ajal ühtegi CRM-i kirjet ei muudeta. Tagastab ridade toimingud ja vead, partii ID ning kinnitusräsi. Eelvaateplaanid ja korduskatsete kviitungid aeguvad seitsme päeva pärast ning eemaldatakse korralise puhastuse või järgmise impordiga selles tööruumis. |
| GET POST | /imports/:id | Partiid saab lugeda ja jätkata ainult selle omanik. Ülevaadatud eelvaate kinnituse POST-päring rakendab korraga kuni kümme rida, iga rea puhul atomaarselt koos seotud kontaktide, väljade, märkmete ja ajalooga. Korda sama ID-d ja räsi kuni valmimiseni; tehtud ridu uuesti ei käivitata. Samaaegsed CRM-i muudatused lükkavad aegunud eelvaated tagasi: loe väärtus next_row ja loo seejärel eelvaade ainult allesjäänud ridadele. Tööruumi kohta hoitakse alles kuni 100 partiid. |
| POST | /import | Vanem kohene import ilma turvalise korduskäivituseta; eelista otspunkti /imports/preview. Impordi kuni 500 ettevõtet, inimest või müügivõimalust; tagastab loodud, uuendatud, vahelejäetud ja kärbitud kirjete arvu ning nummerdatud reavead. Mahupiiri täitumisel saab olemasolevaid kontakte endiselt täiendada. |
| PUT | /deals/:id | Kasuta järjestuse muutmiseks välju before_id (müügivõimalus sihtetapis või null viimaseks paigutamiseks), stage_id ja revision. Kaartide järjestamine ei muuda etapis viibimise kestust. |
| POST | /deals/move | Vaata eelvaadet või rakenda kuni 100 avatud müügivõimaluse liigutamist: deal_ids, pipeline_id, stage_id, preview. Rakenda tagastatud väärtusega preview_hash. Aegunud eelvaated ebaõnnestuvad; tulemused tagastatakse iga müügivõimaluse kohta. |
| GET POST | /views/:entity | Salvestatud vaated müügivõimaluste, inimeste või ettevõtete jaoks. GET tagastab loetavad vaated, väljade ja operaatorite kataloogi ning vaikeväärtused. Advanced-kasutajad saavad luua privaatseid vaateid; haldurid saavad luua tööruumi vaateid. POST: name, sharing (private/workspace), revision:0, definition {version:1, columns, sort, filter}. Tööruumiga jagamine ei laienda kunagi andmetele juurdepääsu. |
| PUT | /views/:entity/:id | Uuenda vaadet koos oodatava väärtusega revision. Jagamisviis (sharing) on muutumatu; selle muutmiseks salvesta koopia. Privaatset vaadet saab uuendada ainult omanik; jagatud vaateid uuendavad ainult haldurid. archived:true peidab vaate. Tööruumi kohta kuni 100 aktiivset vaadet. |
| POST | /query/:entity | Üks valideeritud päring loendite ja CSV-lehekülgede jaoks. Saada definition või view_id, offset (0..100000), limit (1..100) ja format (json/csv). Definitsioon: version:1, columns (1..20 ID-d), sort (kuni 3 {field,direction} kirjet), filter {op:and/or,rules:[groups või {field,op,value}]}. Kuni 20 sõlme ja sügavus 3. Väärtused on seotud parameetrid, mitte kunagi SQL. owner_id eq me lahendatakse praeguse kasutaja jaoks; value_cents kasutab sente. has_task kaasab kuupäevata avatud ülesanded, next_task on varaseima kuupäevaga avatud ülesanne. Vastus sisaldab välju total, next_offset ja ridu või valemiohutu CSV-d. CSV-s asendatakse valikute ID-d nimetustega. Tühjad võrdlused kasutavad väärtusi empty/not_empty; muud võrdlused jätavad puuduvad väärtused välja. Vaated ja eksport jäävad loetavaks ka pärast Advanced-juurdepääsu lõppemist. Lehekülgedeks jaotamine on järjestatud ID-põhise viigilahutusega, kuid ei ole päringuteülene hetktõmmis. |
| GET PUT | /layouts/:entity | Jagatud kaardipaigutus ettevõtete, inimeste või müügivõimaluste jaoks. GET tagastab väljad layout, defaults, revision, schema_revision ja fields. Advanced-haldurid saavad teha PUT-päringu objektiga layout {main, side, details}, mõlema versiooninumbriga ja kõigi väljadega järjestatud {id, group_name} objektidena, sealhulgas arhiveeritud väljadega. Iga jaotis ja detailivõti peab esinema täpselt üks kord; HTML ega peidetud jaotised pole lubatud. Liikmetel ja ilma Advancedita tööruumidel säilib lugemisõigus. |
| GET POST | /fields/:entity | Loetle või loo kohandatud välju ettevõtete, inimeste või müügivõimaluste jaoks. Loomine nõuab Advanced-halduri õigusi. Tüübid: text, long_text, number, date, boolean, select, multi_select. Valikuline group_name ja position. |
| PUT | /fields/deals/:id/rules | Advanced-haldur: vaata eelvaadet ja asenda ulatuse visible_in/required_in väärtused (pipeline_id, valikuline stage_id). Nõuab välja revision, esmalt preview:true ja seejärel preview:false koos tagastatud väärtusega preview_hash. Tühi visible_in tähendab nähtavust kõikjal; kohustuslikud väljad jäävad alati nähtavaks. Eelvaade toob välja olemasolevad avatud müügivõimalused, millel puuduvad nõutud väärtused. |
| PUT | /fields/:entity/:id | Uuenda välju name, group_name, position, archived ja options koos oodatava väärtusega revision. Olemasoleva välja tüüpi ei saa muuta. Müügivõimaluse loomine võtab vastu objekti custom_fields, mille võtmeteks on väljade ID-d; puuduvad kohustuslikud etapiväärtused tagastavad koodi 422 loomisel, etapi muutmisel ja taasavamisel, sealhulgas impordi ja MCP kaudu. Valikud säilitavad oma ID-d; väljajäetud vanad valikud arhiveeritakse. |
| GET PUT | /:entity/:id/fields | Loe või muuda tüübiga väärtusi välja ID järgi. PUT vajab GET-päringust saadud välju values, revision ja schema_revision; null tühjendab väärtuse. Valikväljad kasutavad valikute ID-sid. Arhiveeritud väljad jäävad loetavaks. Need otspunktid ei toeta veel kohustuslikke ega etapipõhiseid välju. |
| GET POST | /pipelines | Loetle müügitorud (sealhulgas arhiveeritud) või loo uus (name; nõuab Advanced-haldurit) |
| PUT | /pipelines/:id | Uuenda välju name, position, make_default või archived koos oodatava väärtusega revision. Enne arhiveerimist liiguta või sulge avatud müügivõimalused; /deals/move pakub eelvaadet ja tulemusi iga müügivõimaluse kohta. |
| GET | /reports | Aruandetüübid, arvutusmärkused, filtrid ja isiklikud salvestatud aruanded (Advanced-haldur) |
| POST | /reports/run | Käivita definition või view_id kehtivate kirje juurdepääsuõigustega. Valikuline group vastusest, offset, limit kuni 100. Sendid hoitakse valuutade kaupa eraldi. |
| POST PUT | /reports/views, /reports/views/:id | Salvesta isiklik aruanne: name, definition, revision (uue puhul 0); archived:true peidab olemasoleva aruande |
| GET | /capabilities | Kehtivad CRM-i funktsiooniõigused ja lubatud toimingud; see ei tähenda, et iga funktsioon on juba juurutatud |
| GET | /me | Tööruum, pakett ja kasutaja, kelle nimel võti tegutseb |
| GET | /deals?status=open|won|lost&q=&pipeline_id= | Loetle müügivõimalused koos etapi, summa, ettevõtte, kontakti ja pakkumise lugemisolekuga |
| POST | /deals | Loo müügivõimalus (name, company_id või company_name, person_id, value, currency, pipeline_id, stage_id, expected_close) |
| GET PUT DELETE | /deals/:id | Üks müügivõimalus koos ajajoonega; uuenda välju, etappi või olekut; valikuline Advanced close_details või taasavamisel next_activity koos väljaga revision; kustuta |
| POST | /deals/:id/proposals | Seo pakkumine müügivõimalusega ({proposal_id}) |
| DELETE | /deals/:id/proposals/:pid | Eemalda pakkumise seos |
| GET POST | /companies | Loetle või loo ettevõtteid |
| GET PUT DELETE | /companies/:id | Üks ettevõte koos inimeste, müügivõimaluste ja ajajoonega |
| GET POST | /people | Loetle või loo inimesi (kontakte) |
| GET PUT DELETE | /people/:id | Üks inimene koos müügivõimaluste ja ajajoonega |
| GET PUT | /activity-settings | Loe või määra oma IANA ajavöönd; haldurid saavad määrata ka välja workspace_timezone. Null kasutab vaikeväärtust. |
| GET POST | /tasks | Loetle või loo tegevusi. scope=mine|all|unassigned, status=open|done|cancelled|all (vanem done=0|1|all), kirjete ID-d, offset ja limit (max 500). Kui has_more on tõene, järgi väärtust next_offset. |
| GET PUT DELETE | /tasks/:id | Loe, muuda, lõpeta, tühista või kustuta tegevus. Toetatud on märkmed, completed_date, call_result ja atomaarne next_activity. Saada muutmisel revision ja kustutamisel ?revision=; aegunud salvestused tagastavad koodi 409. |
| POST | /notes | Lisa märge müügivõimalusele, inimesele või ettevõttele |
| PUT DELETE | /notes/:id | Muuda või kustuta märge |
| GET | /stages?pipeline_id= | Müügitoru etapid, liikmed ja valuuta (puudumisel vaikimisi müügitoru) |
| PUT | /stages | Salvesta etapid väljadega pipeline_id ja revision. Kasutusel olevatest etappidest tuleb avatud müügivõimalused enne liigutada või sulgeda. Väljajäetud etapid arhiveeritakse. |
| GET | /activity?since=&limit=&deal_id=&person_id=&company_id= | Struktureeritud sündmuselogi, uusimad eespool. since on Unixi millisekundite ajatempel |
| GET | /search?q= | Ettevõtted, inimesed ja müügivõimalused ühes otsingus |
| GET | /visitors?days=7|30|90 | Tiny Ant Visitors: sinu veebilehte külastanud ettevõtted, vaadatud lehed, viimane külastus, CRM-i seos ning kodu-, mobiili- ja andmekeskuste külastuste osakaal |
| GET POST | /visitors/settings | Visitorsi olek ja koodilõik; lülita sisse või välja ({enabled}), ühenda või eemalda ipapi.is ({ipapi_key}) |
| POST | /visitors/companies/:id/add | Lisa külastanud ettevõte CRM-i |
| GET | /proposals?status=active|won|closed|archived | Pakkumised koos külastuste, lugemisaja ja seotud müügivõimalusega |
| GET | /proposals/:id | Üks pakkumine koos lehekülgede lugemisaja, saajate, tegevuse ja versioonidega |
| POST | /proposals | Laadi pakkumine üles (sama päringukeha nagu rakenduses: multipart koos PDF-faili, nime ja lehekülgedega) |
| POST | /proposals/:id/status | Määra olek ({status: active|closed|won}) |
Tegevused
Ülesannete otspunktid salvestavad ka kõnesid, kohtumisi ja järeltegevusi tööruumides, millel on CRM Advanced paketis Team, Enterprise või aktiivses piloodis. Saada activity_type (task, call, meeting või follow_up), due_date (YYYY-MM-DD), valikuline due_time (HH:mm), timezone (IANA nimi), duration_minutes (1 kuni 1440), assignee_id ning valikuline deal_id, person_id või company_id. Ainult kuupäevaga ülesanded säilitavad oma kalendrikuupäeva. Puuduva ajavööndi korral kasutatakse esmalt kasutaja eelistust, seejärel tööruumi oma ja viimaks UTC-d. Olematu kohalik kellaaeg lükatakse tagasi; korduva kellaaja korral on nõutud occurrence: earlier või later. Loe tegevus enne muutmist sisse ja saada selle revision; aegunud muudatused tagastavad koodi 409. Vanemad kliendid võivad välja revision ära jätta. Null tühjendab valikulised väljad. Loetle parameetritega scope=mine, all või unassigned, done=0, 1 või all, valikulised kirjete ID-d, limit kuni 500 ja offset; kui has_more on tõene, järgi väärtust next_offset. Pärast Advanced-juurdepääsu lõppemist jäävad olemasolevad tüübiga tegevused muudetavaks ja lõpetatavaks ning uute tavaliste ülesannete loomine jääb kättesaadavaks. Tegevused ei tee kõnesid, ei saada sõnumeid ega kutsu inimesi kohtumistele. Tegevuse lõpetamine ei märgi müügivõimalust ega pakkumist võidetuks.
Salvesta e-kiri, SMS, LinkedIni sõnum või muu suhtlus kui activity_type: follow_up koos väljaga contact_channel: email, sms, linkedin või other (Advanced). Tegevuse märkmed mahutavad kuni 10 000 märki. done: true registreerib lõpetamise; completed_date on kujul YYYY-MM-DD ega tohi olla tänasest hilisem. Kõne lõpetamine nõuab välja call_result: answered, no_answer või busy. cancelled: true tühistab kirje seda kustutamata; done ja cancelled ei saa korraga olla tõesed. Loetle parameetriga status: open, done, cancelled või all; tühistatud kirjed jäetakse avatud tööloenditest ja tegevusaruannetest välja.
Tegevuse salvestamine võib sisaldada objekti next_activity: {title, due_date, activity_type, contact_channel, notes, assignee_id}; uus kirje pärib müügivõimaluse ning selle kuupäev peab olema täna või hilisem. Olemasoleva kirje liitsalvestused nõuavad välja revision. Mõlemad muudatused kinnitatakse atomaarselt. Advanced-õigustega haldur saab müügitorul lubada seade require_next_activity. Avatud müügivõimalusele peab siis jääma avatud tegevus, kui selle viimane tegevus lõpetatakse, tühistatakse, eemaldatakse või lahti seotakse, samuti müügivõimaluse taasavamisel. Müügivõimaluse loomine või liigutamine ilma tegevuseta on endiselt lubatud. Nõue kaotab kehtivuse, kui Advanced-juurdepääs lõpeb.
Advanced-taseme müügivõimaluste uuendused võivad sisaldada objekti close_details koos olekuga status won või lost ja väljaga revision: close_date (mitte hilisem kui täna), open_activities (keep või cancel), valikuline notes ning võitude puhul won_reason või kaotuste puhul loss_category. Kaotuse kategooriad on price, timing, no_need, competitor, no_response, no_authority_or_budget, in_house, poor_fit ja other. Valikuline väli competitor kehtib kategooria competitor puhul; revisit_date peab olema tulevane kuupäev ega loo meeldetuletust. Olek won nõuab positiivset müügivõimaluse summat. Sulgemine ja tegevuste tühistamine kinnitatakse koos vastavalt kehtivatele kirje õigustele. Taasavamiseks saada status: open ja vajaduse korral next_activity. Taasavamine kustutab sulgemise üksikasjad, kuid ei taasta tühistatud tegevusi. Vanemad, ainult olekut muutvad uuendused on endiselt toetatud.
Näited
Loetle avatud müügivõimalused:
curl https://app.tinyant.io/api/v1/deals?status=open \
-H "Authorization: Bearer ta_live_..."Loo müügivõimalus ja lase Tiny Antil ettevõte nime järgi luua või siduda:
curl -X POST https://app.tinyant.io/api/v1/deals \
-H "Authorization: Bearer ta_live_..." \
-H "Content-Type: application/json" \
-d '{"name": "Website redesign", "company_name": "Acme Ltd", "value": 12500}'Kõik pärast kindlat ajatemplit toimunud sündmused, näiteks oma süsteemi sünkroonimiseks:
curl "https://app.tinyant.io/api/v1/activity?since=1760000000000&limit=100" \
-H "Authorization: Bearer ta_live_..."MCP-server
MCP (Model Context Protocol) server asub aadressil:
https://app.tinyant.io/mcpTranspordiks on Streamable HTTP, olekuta, JSON-RPC üle POST-päringute. Autentimiseks kasutatakse sama Bearer-võtit. Serveri algatatud vooge ei ole, seega piisab tavalisest HTTP-kliendist.
Claude Code. Üks rida terminalis ja saadki Claude'ilt oma müügivõimaluste kohta küsida:
claude mcp add --transport http tiny-ant https://app.tinyant.io/mcp --header "Authorization: Bearer ta_live_..."Teised MCP-kliendid. Kasuta klienti, mis toetab Streamable HTTP-d ja kohandatud Authorization-päist. Määra serveri URL-iks ülaltoodud aadress ning päise väärtuseks Bearer, millele järgneb sinu API-võti. Kontrolli kliendi kehtivaid ühendusvalikuid. Kui otsene MCP-tugi puudub, saab kohandatud integratsioon teha päringuid REST API kaudu. Tiny Ant ei paku iga kliendi jaoks valmis integratsiooni.
OAuth. Avaldatud Tiny Anti MCP-ühendus kasutab praegu staatilist Bearer-võtit. Klient, mis nõuab OAuthi, ei saa seda ühendust otse kasutada. Kontrolli ühilduvust enne kliendi valimist.
MCP-tööriistad
Iga tööriist pöördub sama ülalmainitud API poole ja tagastab JSON-vastuse tekstina.
| Tööriist | Kirjeldus |
|---|---|
search | Otsi CRM-ist ettevõtteid, inimesi ja müügivõimalusi nime, e-posti või domeeni järgi. |
list_deals | Loetle müügivõimalused. |
get_deal | Ühe müügivõimaluse täisvaade: üksikasjad, ettevõte, kontakt, pakkumised koos lugemisandmetega, ülesanded ning märkmete ja sündmuste ajajoon. |
create_deal | Loo müügivõimalus. |
update_deal | Uuenda müügivõimalust: nimeta ümber, muuda summat, liiguta etappi, märgi võidetuks või kaotatuks, seo ettevõte või kontakt. |
list_companies | Loetle ettevõtted koos inimeste arvu, avatud müügivõimaluste ja avatud kogusummaga. |
get_company | Üks ettevõte koos oma inimeste, müügivõimaluste ja ajajoonega. |
create_company | Loo ettevõte. |
list_people | Loetle inimesed (kontaktid), soovi korral ühe ettevõtte kaupa. |
get_person | Üks inimene koos müügivõimaluste ja ajajoonega. |
create_person | Loo kontakt. |
add_note | Lisa märge müügivõimalusele, inimesele või ettevõttele. |
list_tasks | Loetle võtme omaniku (mine) või kõigi avatud ülesanded. |
create_task | Loo ülesanne, soovi korral seotuna müügivõimaluse, inimese või ettevõttega. |
get_task | Loe tegevust koos selle versiooninumbriga (revision). |
update_task | Muuda tegevust. |
get_activity_settings | Loe kehtivat tegevuste ajavööndit ja saadaolevaid tüüpe. |
complete_task | Märgi ülesanne tehtuks (või ava uuesti väärtusega done=false). |
get_crm_capabilities | Selle kasutaja kehtivad CRM-i funktsiooniõigused ja lubatud toimingud. |
list_stages | Ühe müügitoru etapid (puudumisel vaikimisi müügitoru), tööruumi liikmed ja valuuta. |
move_deals | Vaata eelvaadet või rakenda kuni 100 avatud müügivõimaluse liigutamist. |
get_dashboard | Loe oma isiklikku töölauda koos reaalajas õigustega piiratud mõõdikutega. |
save_dashboard | Salvesta oma töölaua paigutus ja filtrid tööriistast get_dashboard saadud versiooninumbriga. |
list_automations | Loe oma API-võtmega seotud automaatikareegleid ja viimaseid juurdepääsetavaid käivitustulemusi. |
preview_automation | Valideeri reegel ja vaata sobivate avatud müügivõimaluste eelvaadet ilma muudatusteta. |
save_automation | Loo või muuda reeglit eelvaatest saadud kinnitusega. |
simulate_automation | Lisa järjekorda üks simulatsioon praegu sobiva müügivõimaluse jaoks. |
stop_automation | Lülita reegel välja ja tühista selle ootel käivitused. |
archive_automation | Arhiveeri reegel ja tühista selle ootel käivitused. |
cancel_automation_run | Tühista ootel käivitus. |
list_automation_notifications | Loe oma sisemisi automaatikateavitusi kehtiva müügivõimaluste juurdepääsuga. |
list_reports | Loe aruandetüüpe, arvutusmärkusi, filtreid ja isiklikke salvestatud aruandeid (Advanced-haldur). |
run_report | Käivita aruanne kehtivate kirje juurdepääsuõigustega. |
save_report | Salvesta isikliku aruande definitsioon. |
list_views | Loetle loetavad salvestatud vaated, väljade ja operaatorite kataloog ning vaikeväärtused. |
query_records | Sirvi valideeritud CRM-i vaadet lehekülgede kaupa. |
preview_bulk_change | Vaata 1 kuni 100 valitud CRM-i kirje eelvaadet. |
get_bulk_change | Loe oma hulgieelvaadet ja püsivaid reatulemusi seitsme päeva jooksul sama API-võtmega. |
apply_bulk_change | Rakenda kuni viis eelvaadatud rida atomaarselt rea kaupa. |
preview_import | Vaata kuni 100 CRM-i rea eelvaadet kirjeid muutmata. |
get_import | Loe oma impordi eelvaadet ja püsivat edenemist; partiid aeguvad seitsme päeva pärast. |
apply_import | Rakenda kuni kümme eelvaadatud rida atomaarselt rea kaupa. |
save_view | Loo või uuenda isiklikku vaadet või haldurina tööruumi vaadet (Advanced). |
get_card_layout | Loe jagatud kaardi jaotisi, detailide järjestust ja kohandatud väljade rühmi. |
set_card_layout | Asenda jagatud kaardipaigutus ja kohandatud väljade rühmad (Advanced-haldur). |
list_fields | Loetle kohandatud väljade definitsioonid, sealhulgas arhiveeritud väljad ja püsivad valikud. |
create_field | Loo kohandatud väli (Advanced-haldur). |
update_field | Nimeta väli ümber, muuda järjestust, rühmita või arhiveeri see (Advanced-haldur). |
set_field_rules | Vaata eelvaadet või salvesta müügivõimaluse väljade nähtavus ja kohustuslikud ulatused (Advanced-haldur). |
get_record_fields | Loe kirje kohandatud välju, väärtusi ja versiooninumbrit. |
set_record_fields | Uuenda kohandatud väljade väärtusi välja ID järgi. |
list_pipelines | Loetle tööruumi müügitorud, sealhulgas arhiveeritud, ja vaikimisi müügitoru. |
create_pipeline | Loo nelja algse etapiga müügitoru. |
update_pipeline | Nimeta müügitoru ümber, muuda järjestust, arhiveeri või määra vaikimisi müügitoruks. |
set_stages | Asenda müügitoru aktiivsed etapid. |
activity | Tööruumi struktureeritud sündmuselogi, uusimad eespool: loodud ja liigutatud müügivõimalused, võidetud ja kaotatud müügivõimalused, märkmed, ülesanded, seotud ja loetud pakkumised. |
list_proposals | Pakkumised koos lugemisolekuga: külastused, kogu lugemisaeg, praegu loetav, seotud müügivõimalus. |
get_proposal | Üks pakkumine: lugemisaeg lehekülje kaupa, saajad, tegevus, versioonid, seotud müügivõimalus. |
list_visitors | Sinu veebilehte külastanud ettevõtted (Tiny Ant Visitors): nimelised ettevõttevõrgud koos vaadatud lehtede, viimase külastuse ja seotud CRM-i ettevõttega, lisaks kodu-, mobiili- või andmekeskuste võrkudest tulnud külastuste arv. |
link_proposal | Seo olemasolev pakkumine müügivõimalusega, et selle lugemine ilmuks müügivõimaluse ajajoonele. |
Päringupiirangud ja mõistlik kasutus
MCP võtab ühe POST-päringu kohta vastu ühe JSON-RPC sõnumi mahuga kuni 512 KiB. JSON-massiivid lükatakse tagasi ühtegi tööriista käivitamata. Saada päringud eraldi. CRM-i mitte-GET-päringud, sealhulgas impordid, hulgitoimingud ja päringute eelvaated, jagavad rakenduse, REST-i ja MCP vahel täiendavat tööruumipõhist limiiti 120 päringut minutis; keeldumisel tagastatakse 429 ja Retry-After. Need piirangud on kohalikud igas Cloudflare'i asukohas.
CRM-i mõistliku kasutuse mahupiirid kehtivad iga tabeli kohta eraldi (müügivõimalused, ülesanded ja märkmed): Free 500, Pro 20 000, Team ja Enterprise 50 000. Free paketis on ka eraldi 10 avatud müügivõimaluse piir. Tehtud ülesanded ja suletud müügivõimalused arvestatakse samuti mahupiiride sisse; paketi madalamaks vahetamisel säilitatakse olemasolevad kirjed.
Visitors võtab tööruumi ja UTC-päeva kohta vastu kuni 5 000 lehevaatamist Pro, 20 000 Team ja 50 000 Enterprise paketis. Piiri ületav liiklus jäetakse salvestamata; kogumine jätkub järgmisel päeval. Päevalimiit kasutab jagatud andmebaasiloendurit; servakaitse piirab lisaks lähte-IP-aadressi 60 ja avaliku Visitorsi võtme 600 signaalini minutis iga Cloudflare'i asukoha kohta. Ebaõnnestunud päring või salvestus pärast koha broneerimist võib kulutada päevalimiiti. Kliendi ipapi.is kvoot on eraldi.
Iga võti võib teha REST API ja MCP-serveri peale kokku 120 päringut minutis ning iga aadress 300 päringut minutis. Ilma kehtiva võtmeta päringud on piiratud 30 päringuga minutis aadressi kohta. Piiri ületamisel saad vastuseks 429 koos päisega Retry-After; oota ja proovi uuesti. Terve loendi uuesti lugemise asemel küsi muudatusi otspunktist /activity parameetriga since, kasuta iga integratsiooni jaoks eraldi võtit, et saaksid selle eraldi tühistada, ja ära jaga võtit inimestega väljaspool oma tööruumi. Tööruumil võib olla kuni 10 aktiivset võtit.
CRM Advancedi automaatikareeglid algavad simulatsiooniga. Piirid on 50 aktiivset reeglit ja 1 000 käivitust libiseva 24 tunni jooksul tööruumi kohta. Müügivõimaluse loomine ja etapi muutmine lisatakse järjekorda atomaarselt. Kinnitatud välised pakkumise avamised on piiratud ühe korraga pakkumise ja UTC-päeva kohta. Seisma jäänud müügivõimaluste tähtaegadel on seitsmepäevane järelejõudmisaken. Käivitused ja sisemised teavitused säilitatakse 90 päeva. Kliendiandmeid ei saadeta tehisintellekti mudelile ega välisele sõnumiteenusele.
Advanced-õigustega haldurid saavad käivitada avatud müügitoru, võidetud ja kaotatud müügivõimaluste ning võiduprotsendi, etappide ajaloo, tegevuste ja kaalutud prognoosi aruandeid. Kuupäevad on kaasavad UTC-päevad (kuni 366); planeeritud tegevused kasutavad oma tähtaega. Prognoosid kasutavad praeguseid avatud müügivõimalusi ja etappide tõenäosusi, hoides kuupäevata müügivõimalused ja valuutad eraldi. Baasvaatlused ei ole ajaloolised etappi sisenemised ega teadaolevad kestused. Salvestatud isiklikud aruanded talletavad valikud, mitte tulemuste hetktõmmised. Iga käivitus ja süvavaade rakendab kehtivaid kirjete juurdepääsuõigusi.
CRM Advancediga jõustatakse kirjete juurdepääsuõigused rakenduses, REST API-s, MCP-s ja eksportides. API-võtmed ja webhook'id näevad vaikimisi tööruumiga jagatud kirjeid, sealhulgas jagatud emakirjeid. Haldur saab selgesõnaliselt luua integratsiooni kõigi tööruumi kirjete, sealhulgas privaatsete kirjete jaoks. Ulatus kuvatakse seadetes. Olemasolevad piirangud jäävad kehtima ka pärast Advanced-juurdepääsu lõppemist. Avalikud pakkumiste saajalingid jäävad eraldi jagamiskanaliks.
Webhook'id
Kui soovid, et Tiny Ant teavitaks hoopis sinu süsteemi, saad samal seadete lehel seadistada väljuvad webhook'id. Need saadavad allkirjastatud JSON POST-päringu, kui pakkumine avatakse, lugemine lõpeb, olek muutub või müügivõimalus luuakse või liigub etappide vahel.
Küsimused
Kirjuta aadressil hello@tinyant.io. API muudatustest antakse teada sellel lehel.