Yhdistä Tiny Ant omiin työkaluihisi
REST-rajapinta, MCP-palvelin ja webhookit
REST-rajapinnan avulla voit käsitellä diilejä, yhteystietoja, tehtäviä, tarjouksia ja sivuston yrityskävijätietoja. MCP-palvelin tuo nämä toiminnot yhteensopivien tekoälyavustajien käyttöön. API-avain voi sekä lukea että muuttaa työtilan tietoja, joten yhdistä vain työkaluja, joihin luotat.
Todennus
Jokaisessa pyynnössä välitetään työtilan API-avain Authorization-otsakkeessa:
Authorization: Bearer ta_live_...Työtilan ylläpitäjät luovat avaimet sovelluksen Asetukset-sivulla (osio API ja MCP). Avain näytetään vain kerran luontihetkellä, ja sen voi peruuttaa milloin tahansa. Jos avaimen luoneen ylläpitäjän rooli vaihdetaan jäseneksi, hänen avaimensa peruuntuvat pysyvästi; myös luojan poistaminen työtilasta mitätöi avaimet. Ylentäminen uudelleen ylläpitäjäksi ei palauta vanhoja avaimia. Avaimia ei voi käyttää, jos työtila on jäädytetty. Avain toimii sen luoneen ylläpitäjän nimissä: muistiinpanot, tehtävät ja tapahtumat kirjataan kyseiselle henkilölle, ja kaikki avaimella luotu näkyy koko työtilalle. REST-rajapinta ja MCP-palvelin sisältyvät Pro- ja Team-tasoihin. Luo ja hallitse avaimia kohdassa Asetukset → API ja MCP.
Ilman kelvollista avainta tehdyistä pyynnöistä palautuu 401. Free-tasolla olevasta työtilasta palautuu 403.
Perusosoite
https://app.tinyant.io/api/v1Useimmat pyynnöt ja vastaukset käyttävät JSON-muotoa (UTF-8). Tarjousten lähetyksessä käytetään multipart-lomakedataa alla kuvatulla tavalla. Tunnisteet ovat muotoa de_, co_, pe_, ta_ ja no_, joiden perässä on 12 merkkiä; tarjousten tunnisteet ovat 12 merkkiä ilman etuliitettä. Aikaleimat ovat Unix-millisekunteja. Alla olevat päätepisteet kuvaavat julkaistun integraatiorajapinnan. Voit käyttää sovelluksen omia verkkopyyntöjä esimerkkeinä silloin, kun koko tietorakennetta ei ole dokumentoitu tässä.
Päätepisteet
| Metodi | Polku | Mitä se tekee |
|---|---|---|
| GET POST PUT DELETE | /automations, /automations/:id | CRM Advanced: ylläpitäjän säännöt ja viimeisimmät 100 käytettävissä olevaa ajoa. POST/PUT vaatii kentät name, definition, esikatselusta saadun confirmation-arvon, revision (uudelle 0) sekä mode off|simulate|live. Aloita tilasta simulate; live edellyttää muuttumattoman version onnistunutta simulointia. API-säännöt pysyvät sidottuina alkuperäiseen ylläpitäjään ja avaimeen. Omistajuutta muuttavat toiminnot ovat käytettävissä vain sovelluksessa. DELETE arkistoi säännön ja peruu odottavat ajot. |
| POST | /automations/preview | Validoi {definition}: version:1; käynnistin deal_created|stage_changed|stalled|proposal_opened; valinnainen pipeline_id, stage_id, owner_id; stalled after_days 1..90. Yksi toiminto: create_task {title,delay_days:0..90,assignee_id}, set_field {field:expected_close,value:YYYY-MM-DD} tai notify {assignee_id}. Vastuuhenkilö on nykyisen jäsenen tunniste tai deal_owner. Palauttaa confirmation-arvon ja enintään 20 täsmäävää esimerkkiä. Ei tee muutoksia. |
| POST | /automations/:id/simulate, /automations/:id/stop, /automations/:id/cancel | Aseta simulointi jonoon {deal_id}, pysäytä sääntö {} tai peru odottava ajo {run_id}. Taustasuoritus tarkistaa senhetkiset käyttöoikeudet uudelleen. Muutokset ja kuitit tallennetaan yhdessä; uudelleenyritykset eivät koskaan toista jo vahvistettua toimintoa. Ei lähetä ulkoisia sähköposteja. |
| GET | /automation-notifications | Nykyisen käyttäjän sisäinen saapuneiden kansio, suodatettuna senhetkisten diilioikeuksien mukaan. Ei sähköposti- tai selainilmoituksia. |
| GET PUT | /dashboard | Henkilökohtainen koontinäkymä: GET palauttaa korttivalikoiman, tallennetut asetukset ja käyttöoikeuksien mukaiset reaaliaikaiset tunnusluvut; PUT {revision,config} tallentaa vain nykyisen käyttäjän asettelun ja suodattimet. Asetusten versio 1: days 7/30/90, owner all/mine/unassigned, tyhjäksi jätettävissä olevat pipeline_id ja currency sekä yksilölliset kortit {id,size} valikoimasta leveyksillä 4/6/8/12. Ennuste ja tulokset vaativat CRM Advanced -ylläpitäjän oikeudet; Visitors vaatii maksullisen tason. Tietoja ei koskaan tallenneta asettelujen mukana. API-avaimet säilyttävät nykyisen tietuelaajuutensa. |
| GET | /bulk | Nykyiset jäsenet, aktiviteettiasetukset ja 20 viimeisintä massaerääsi. Massatoiminnon esikatselu ja etenemisen seuranta on rajattu sen luojalle ja samalle API-avaimelle. |
| POST | /bulk/preview | Esikatsele 1–100 nimettyä yritystä, henkilöä tai diiliä kentillä entity, ids ja action: activity sekä samoilla aktiviteettikentillä kuin tehtävän luonnissa. Palauttaa valitut nimet, tietuekohtaisen validoinnin ja confirmation-arvon. Aktiviteetin luonti noudattaa nykyisiä muokkausoikeuksia sekä samoja ajastus-, Advanced-tyyppi- ja kapasiteettitarkistuksia kuin yksittäiset aktiviteetit. Vastuuhenkilön vaihdot voi tehdä vain työtilan sovelluksessa ja vain ylläpitäjänä tietueiden käyttöoikeushallinnan mukaisesti. |
| GET POST | /bulk/:id | Lue esikatselu tai tulokset tai toteuta POST-pyynnöllä ja confirmation-arvolla enintään viisi riviä atomisesti kutsua kohden. Toista samalla tunnisteella ja tiivisteellä, kunnes erä on valmis; jo suoritetut rivit eivät toistu. Tulokset ovat applied, skipped, failed tai pending. CRM- tai käyttöoikeusmuutokset mitätöivät odottavan työn. Tarkista tulokset ja esikatsele vain jäljellä olevat tietueet. Työtilaa kohden säilytetään enintään 100 erää seitsemän päivän ajan, minkä jälkeen ne poistetaan ajastetussa siivouksessa tai seuraavan massaesikatselun yhteydessä. Omistajan tai työtilan poistaminen poistaa myös esikatselut ja kuitit. Sähköposteja tai kutsuja ei lähetetä. |
| GET | /imports/catalog | Kenttä- ja myyntiputkivalikoima tuonnin sarakkeiden yhdistämiseen. Kaikki CRM-jäsenet voivat esikatsella ja tuoda tietoja; omien kenttien ja lisämyyntiputkien määritys vaatii edelleen CRM Advancedin. |
| POST | /imports/preview | Esikatsele 1–100 riviä (enintään 500 kt) parametreilla kind ja duplicates: fill tai skip. Tukee custom_fields-arvoja pysyvällä tunnisteella, myyntiputkien ja vaiheiden tunnisteita tai yksiselitteisiä nimiä sekä suoria tietuetunnisteita. Fill täyttää vain tyhjät arvot; olemassa olevan diilin arvo, tila ja vaihe säilyvät ennallaan. Toistuvat tietueet ohitetaan. Esikatselu ei muuta CRM-tietueita. Palauttaa rivikohtaiset toiminnot ja virheet, erän tunnisteen ja vahvistustiivisteen. Esikatselusuunnitelmat ja uudelleenyrityskuitit vanhenevat seitsemän päivän kuluttua, ja ne poistetaan ajastetussa siivouksessa tai seuraavan tuonnin yhteydessä samassa työtilassa. |
| GET POST | /imports/:id | Vain erän omistaja voi lukea erän tai jatkaa sitä. Tarkistetusta esikatselusta lähetetty POST-vahvistus toteuttaa enintään kymmenen riviä kerrallaan, kunkin atomisesti mukaan lukien liittyvät yhteystiedot, kentät, muistiinpanot ja historian. Toista samalla tunnisteella ja tiivisteellä, kunnes erä on valmis; valmiit rivit eivät toistu. Samanaikaiset CRM-muutokset hylkäävät vanhentuneen esikatselun: lue next_row ja esikatsele vain jäljellä olevat rivit. Työtilaa kohden säilytetään enintään 100 erää. |
| POST | /import | Aiempi välitön tuonti ilman turvallista uudelleenajoa; suosittelemme päätepistettä /imports/preview. Tuo enintään 500 yritystä, henkilöä tai diiliä; palauttaa luodut, päivitetyt, ohitetut ja lyhennetyt tietueet sekä numeroidut rivivirheet. Olemassa olevia yhteystietoja voi täydentää myös kapasiteetin ollessa täynnä. |
| PUT | /deals/:id | Järjestä kortit uudelleen lähettämällä before_id (kohdevaiheessa oleva diili tai null viimeiseksi sijoittamiseen), stage_id ja revision. Korttien järjestäminen ei muuta vaiheen kestoa. |
| POST | /deals/move | Esikatsele tai toteuta enintään 100 avoimen diilin siirto: deal_ids, pipeline_id, stage_id, preview. Toteuta siirto palautetulla preview_hash-arvolla. Vanhentuneet esikatselut hylätään; tulokset palautetaan diilikohtaisesti. |
| GET POST | /views/:entity | Tallennetut näkymät diileille, henkilöille tai yrityksille. GET palauttaa luettavissa olevat näkymät, kenttä- ja operaattorivalikoiman sekä oletukset. CRM Advanced -käyttäjät voivat luoda yksityisiä näkymiä, ja ylläpitäjät voivat luoda työtilan näkymiä. POST: name, sharing (private/workspace), revision:0, definition {version:1, columns, sort, filter}. Työtilanlaajuinen jako ei koskaan laajenna käyttöoikeuksia tietueisiin. |
| PUT | /views/:entity/:id | Päivitä näkymä odotetulla revision-arvolla. Jakotapaa ei voi muuttaa jälkikäteen; tallenna kopio, jos haluat vaihtaa sitä. Vain omistaja voi päivittää yksityisen näkymän, ja vain ylläpitäjät voivat päivittää jaettuja näkymiä. archived:true piilottaa näkymän. Enintään 100 aktiivista näkymää työtilaa kohden. |
| POST | /query/:entity | Yksi validoitu kysely listoille ja CSV-sivuille. Lähetä definition tai view_id, offset (0..100000), limit (1..100) ja format (json/csv). Määritys: version:1, columns (1..20 tunnistetta), sort (enintään 3 {field,direction}-alkiota), filter {op:and/or,rules:[groups or {field,op,value}]}. Enintään 20 solmua ja syvyys 3. Arvot sidotaan parametreina, ei koskaan raakana SQL:nä. owner_id eq me kohdistuu nykyiseen käyttäjään; value_cents käyttää senttejä. has_task sisältää myös päiväämättömät avoimet tehtävät, ja next_task on varhaisin päivätty avoin tehtävä. Vastaus sisältää kentät total, next_offset sekä rivit tai kaavaturvallisen CSV:n. CSV:ssä valintojen tunnisteet korvataan nimikkeillä. Tyhjien arvojen vertailuun käytetään operaattoreita empty/not_empty; muut vertailut jättävät puuttuvat arvot pois. Näkymät ja vienti säilyvät luettavina, vaikka CRM Advanced -käyttöoikeus päättyisi. Sivutus järjestetään tunnisteen avulla tasatilanteissa, mutta se ei muodosta pysyvää tilannekuvaa eri pyyntöjen välillä. |
| GET PUT | /layouts/:entity | Jaettu korttiasettelu yrityksille, henkilöille tai diileille. GET palauttaa asettelun, oletukset, revision- ja schema_revision-arvot sekä kentät. CRM Advanced -ylläpitäjät voivat lähettää PUT-pyynnöllä rakenteen layout {main, side, details}, molemmat versiotunnisteet ja kaikki kentät järjestettyinä {id, group_name} -olioina, arkistoidut kentät mukaan lukien. Jokaisen osion ja tietueavaimen on esiinnyttävä täsmälleen kerran; HTML tai piilotetut osiot eivät ole sallittuja. Jäsenillä ja työtiloilla ilman CRM Advancedia säilyy lukuoikeus. |
| GET POST | /fields/:entity | Listaa tai luo omia kenttiä yrityksille, henkilöille tai diileille. Luonti vaatii CRM Advanced -ylläpitäjän oikeudet. Tyypit: text, long_text, number, date, boolean, select, multi_select. Valinnainen group_name ja position. |
| PUT | /fields/deals/:id/rules | CRM Advanced -ylläpitäjä: esikatsele ja korvaa visible_in/required_in-laajuudet (pipeline_id, valinnainen stage_id). Vaatii kentän revision-arvon, ensin preview:true ja sitten preview:false palautetulla preview_hash-arvolla. Tyhjä visible_in tarkoittaa näkyvyyttä kaikkialla; pakolliset kentät pysyvät aina näkyvissä. Esikatselu raportoi avoimet diilit, joista puuttuu vaadittu arvo. |
| PUT | /fields/:entity/:id | Päivitä name, group_name, position, archived ja options odotetulla revision-arvolla. Olemassa olevan kentän tyyppiä ei voi muuttaa. Diilin luonti hyväksyy custom_fields-arvot kentän tunnisteella avaimena; puuttuvat vaihekohtaiset pakolliset arvot palauttavat koodin 422 luonnissa, vaiheen vaihdossa ja uudelleenavaamisessa, myös tuonnissa ja MCP:ssä. Vaihtoehdot säilyttävät tunnisteensa; pois jätetyt vanhat vaihtoehdot arkistoidaan. |
| GET PUT | /:entity/:id/fields | Lue tai päivitä tyypitetyt arvot kentän tunnisteen perusteella. PUT vaatii kentät values, revision ja schema_revision GET-vastauksesta; null tyhjentää arvon. Valintakentissä käytetään vaihtoehtojen tunnisteita. Arkistoidut kentät pysyvät luettavina. Nämä päätepisteet eivät vielä tue pakollisia tai vaihekohtaisia kenttiä. |
| GET POST | /pipelines | Listaa myyntiputket (myös arkistoidut) tai luo uusi (name; vaatii CRM Advanced -ylläpitäjän) |
| PUT | /pipelines/:id | Päivitä name, position, make_default tai archived odotetulla revision-arvolla. Siirrä tai sulje avoimet diilit ennen arkistointia; /deals/move tarjoaa esikatselun ja diilikohtaiset tulokset. |
| GET | /reports | Raporttityypit, laskentaperiaatteet, suodattimet ja henkilökohtaiset tallennetut raportit (CRM Advanced -ylläpitäjä) |
| POST | /reports/run | Aja definition tai view_id nykyisillä tietueiden käyttöoikeuksilla. Valinnainen group vastauksesta, offset sekä limit enintään 100. Sentit pidetään erillään valuutoittain. |
| POST PUT | /reports/views, /reports/views/:id | Tallenna henkilökohtainen raportti: name, definition, revision (uudelle 0); archived:true piilottaa olemassa olevan raportin |
| GET | /capabilities | Nykyiset CRM-ominaisuusoikeudet ja sallitut toiminnot; tämä ei tarkoita, että jokainen ominaisuus olisi otettu käyttöön |
| GET | /me | Työtila, taso ja käyttäjä, jonka nimissä avain toimii |
| GET | /deals?status=open|won|lost&q=&pipeline_id= | Listaa diilit sekä niiden vaihe, arvo, yritys, yhteyshenkilö ja tarjouksen lukutila |
| POST | /deals | Luo diili (name, company_id tai company_name, person_id, value, currency, pipeline_id, stage_id, expected_close) |
| GET PUT DELETE | /deals/:id | Yksi diili aikajanoineen; päivitä kenttiä, vaihetta tai tilaa; valinnainen Advancedin close_details tai uudelleenavattaessa next_activity yhdessä revision-arvon kanssa; poista |
| POST | /deals/:id/proposals | Liitä tarjous diiliin ({proposal_id}) |
| DELETE | /deals/:id/proposals/:pid | Irrota tarjous diilistä |
| GET POST | /companies | Listaa tai luo yrityksiä |
| GET PUT DELETE | /companies/:id | Yksi yritys sekä sen henkilöt, diilit ja aikajana |
| GET POST | /people | Listaa tai luo henkilöitä (yhteystietoja) |
| GET PUT DELETE | /people/:id | Yksi henkilö sekä hänen diilinsä ja aikajanansa |
| GET PUT | /activity-settings | Lue tai aseta oma IANA-aikavyöhykkeesi; ylläpitäjät voivat asettaa myös arvon workspace_timezone. Null palauttaa oletuksen. |
| GET POST | /tasks | Listaa tai luo aktiviteetteja. scope=mine|all|unassigned, status=open|done|cancelled|all (aiempi done=0|1|all), tietuetunnisteet, offset ja limit (enintään 500). Seuraa next_offset-arvoa, kun has_more on voimassa. |
| GET PUT DELETE | /tasks/:id | Lue, muokkaa, kuittaa valmiiksi, peru tai poista aktiviteetti. Tukee kenttiä notes, completed_date, call_result ja atomista next_activity-kirjausta. Lähetä muokkauksissa revision ja poistoissa ?revision=; vanhentuneet kirjoitukset palauttavat koodin 409. |
| POST | /notes | Lisää muistiinpano diiliin, henkilölle tai yritykselle |
| PUT DELETE | /notes/:id | Muokkaa muistiinpanoa tai poista se |
| GET | /stages?pipeline_id= | Myyntiputken vaiheet, jäsenet ja valuutta (oletusmyyntiputki, jos tunnistetta ei anneta) |
| PUT | /stages | Tallenna vaiheet arvoilla pipeline_id ja revision. Käytössä olevien vaiheiden avoimet diilit on siirrettävä tai suljettava ensin. Pois jätetyt vaiheet arkistoidaan. |
| GET | /activity?since=&limit=&deal_id=&person_id=&company_id= | Rakenteinen tapahtumaloki, uusin ensin. since on Unix-aikaleima millisekunteina |
| GET | /search?q= | Yritykset, henkilöt ja diilit yhdellä haulla |
| GET | /visitors?days=7|30|90 | Tiny Ant Visitors: verkkosivustollasi vierailleet yritykset, katsotut sivut, viimeisin käynti, CRM-linkitys sekä koti-, mobiili- ja datakeskuskäyntien osuus |
| GET POST | /visitors/settings | Visitorsin tila ja seurantakoodi; kytke päälle tai pois ({enabled}), yhdistä tai poista ipapi.is ({ipapi_key}) |
| POST | /visitors/companies/:id/add | Lisää sivustolla vieraillut yritys CRM:ään |
| GET | /proposals?status=active|won|closed|archived | Tarjoukset sekä niiden käynnit, lukuaika ja liitetty diili |
| GET | /proposals/:id | Yksi tarjous sekä sen sivukohtainen lukuaika, vastaanottajat, tapahtumat ja versiot |
| POST | /proposals | Lataa tarjous palveluun (sama sisältö kuin sovelluksessa: multipart-pyyntö, jossa on PDF-tiedosto, nimi ja sivumäärä) |
| POST | /proposals/:id/status | Aseta tila ({status: active|closed|won}) |
Aktiviteetit
Tehtäväpäätepisteet tallentavat myös puhelut, tapaamiset ja seurannat työtiloissa, joissa on CRM Advanced (Team, Enterprise tai aktiivinen pilotti). Lähetä activity_type (task, call, meeting tai follow_up), due_date (YYYY-MM-DD), valinnainen due_time (HH:mm), timezone (IANA-nimi), duration_minutes (1–1440), assignee_id sekä valinnainen deal_id, person_id tai company_id. Pelkän päivämäärän sisältävät tehtävät säilyttävät kalenteripäivänsä. Jos aikavyöhyke puuttuu, käytetään ensin käyttäjän asetusta, sitten työtilan asetusta ja lopuksi UTC-aikaa. Olematon paikallinen kellonaika hylätään; kellojen siirrosta johtuva toistuva kellonaika vaatii arvon occurrence: earlier tai later. Lue aktiviteetti ennen muokkausta ja lähetä sen revision; vanhentuneet muokkaukset palauttavat koodin 409. Vanhemmat asiakasohjelmat voivat jättää revision-kentän pois. Null tyhjentää valinnaiset kentät. Listaa parametreilla scope=mine, all tai unassigned, done=0, 1 tai all, valinnaisilla tietuetunnisteilla sekä arvoilla limit (enintään 500) ja offset; seuraa next_offset-arvoa, kun has_more on true. Jos CRM Advanced -käyttöoikeus päättyy, olemassa olevia tyypitettyjä aktiviteetteja voi yhä muokata ja kuitata valmiiksi, ja uusia perustehtäviä voi luoda. Aktiviteetit eivät soita puheluita, lähetä viestejä tai kutsu ihmisiä tapaamisiin. Aktiviteetin kuittaaminen valmiiksi ei merkitse diiliä tai tarjousta voitetuksi.
Kirjaa sähköposti-, SMS-, LinkedIn- tai muu yhteydenotto arvolla activity_type: follow_up ja contact_channel: email, sms, linkedin tai other (Advanced). Aktiviteetin muistiinpanoissa voi olla enintään 10 000 merkkiä. done: true kirjaa aktiviteetin valmiiksi; completed_date on muotoa YYYY-MM-DD, korkeintaan tämä päivä. Puhelun kuittaaminen valmiiksi vaatii arvon call_result: answered, no_answer tai busy. cancelled: true peruu aktiviteetin poistamatta sitä; done ja cancelled eivät voi olla yhtä aikaa true. Listaa parametrilla status: open, done, cancelled tai all; perutut tietueet jätetään pois avoimilta työlistoilta ja aktiviteettiraporteista.
Aktiviteetin tallennukseen voi sisällyttää kentän next_activity: {title, due_date, activity_type, contact_channel, notes, assignee_id}; uusi tietue perii diilin, ja sen päivämäärän on oltava tämä päivä tai myöhempi. Olemassa olevan tietueen yhdistetty tallennus vaatii revision-arvon. Molemmat muutokset tallennetaan atomisesti. CRM Advanced -ylläpitäjä voi ottaa käyttöön asetuksen require_next_activity myyntiputkikohtaisesti. Tällöin avoimella diilillä on oltava avoin aktiviteetti, kun sen viimeinen aktiviteetti kuitataan valmiiksi, perutaan, poistetaan tai irrotetaan, sekä kun diili avataan uudelleen. Diilin luominen tai siirtäminen ilman aktiviteettia on silti sallittua. Vaatimus poistuu käytöstä, jos CRM Advanced -käyttöoikeus päättyy.
CRM Advanced -diilipäivityksiin voi sisällyttää kentän close_details yhdessä arvon status (won tai lost) ja revision-numeron kanssa: close_date (korkeintaan tämä päivä), open_activities (keep tai cancel), valinnainen notes sekä voitoille won_reason tai häviöille loss_category. Häviöluokat ovat price, timing, no_need, competitor, no_response, no_authority_or_budget, in_house, poor_fit ja other. Valinnainen competitor-kenttä koskee competitor-luokkaa; revisit_date-arvon on oltava tulevaisuudessa, eikä se luo automaattista muistutusta. Voitetuksi merkitseminen edellyttää positiivista diilin arvoa. Diilin sulkeminen ja avointen aktiviteettien mahdollinen peruminen tallennetaan yhdessä nykyisten käyttöoikeuksien mukaisesti. Avaa diili uudelleen lähettämällä status: open ja tarvittaessa next_activity. Uudelleenavaaminen tyhjentää sulkemistiedot, mutta ei palauta peruttujen aktiviteettien tilaa. Aiemmat pelkän status-kentän päivitykset toimivat edelleen.
Esimerkit
Listaa avoimet diilit:
curl https://app.tinyant.io/api/v1/deals?status=open \
-H "Authorization: Bearer ta_live_..."Luo diili ja anna Tiny Antin luoda tai yhdistää yritys nimen perusteella:
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}'Kaikki tapahtumat tietyn aikaleiman jälkeen, esimerkiksi oman järjestelmäsi synkronointiin:
curl "https://app.tinyant.io/api/v1/activity?since=1760000000000&limit=100" \
-H "Authorization: Bearer ta_live_..."MCP-palvelin
MCP-palvelin (Model Context Protocol) toimii osoitteessa:
https://app.tinyant.io/mcpSiirtotapa on tilaton Streamable HTTP, jossa JSON-RPC-viestit kulkevat POST-pyyntöinä. Todennukseen käytetään samaa Bearer-avainta. Palvelimen käynnistämiä tietovirtoja ei ole, joten tavallinen HTTP-asiakasohjelma riittää.
Claude Code. Aja yksi rivi päätteessäsi ja kysy sen jälkeen Claudelta diileistäsi:
claude mcp add --transport http tiny-ant https://app.tinyant.io/mcp --header "Authorization: Bearer ta_live_..."Muut MCP-asiakasohjelmat. Käytä asiakasohjelmaa, joka tukee Streamable HTTP -yhteyttä ja mukautettua Authorization-otsaketta. Aseta palvelimen osoitteeksi yllä oleva URL ja otsakkeen arvoksi Bearer sekä sen perään oma API-avaimesi. Tarkista asiakasohjelman ajantasaiset yhteysasetukset. Jos suoraa MCP-tukea ei ole, oma integraatio voi kutsua REST-rajapintaa. Tiny Ant ei tarjoa valmista integraatiota jokaiselle asiakasohjelmalle.
OAuth. Julkaistu Tiny Antin MCP-yhteys käyttää tällä hetkellä kiinteää Bearer-avainta. Asiakasohjelma, joka edellyttää OAuth-todennusta, ei voi käyttää yhteyttä suoraan. Tarkista yhteensopivuus ennen asiakasohjelman valintaa.
MCP-työkalut
Kukin työkalu kutsuu samaa yllä kuvattua rajapintaa ja palauttaa JSON-vastauksen tekstinä.
| Työkalu | Kuvaus |
|---|---|
search | Hae yrityksiä, henkilöitä ja diilejä CRM:stä nimen, sähköpostin tai verkkotunnuksen perusteella. |
list_deals | Listaa diilit. |
get_deal | Yhden diilin kokonaisnäkymä: perustiedot, yritys, yhteyshenkilö, tarjoukset katselutietoineen, tehtävät sekä muistiinpanojen ja tapahtumien aikajana. |
create_deal | Luo diili. |
update_deal | Päivitä diili: nimeä uudelleen, muuta arvoa, siirrä vaiheeseen, merkitse voitetuksi tai hävityksi tai liitä yritys tai yhteyshenkilö. |
list_companies | Listaa yritykset sekä niiden henkilömäärä, avoimet diilit ja avointen diilien arvo. |
get_company | Yksi yritys sekä sen henkilöt, diilit ja aikajana. |
create_company | Luo yritys. |
list_people | Listaa henkilöt (yhteystiedot), halutessasi tietylle yritykselle rajattuna. |
get_person | Yksi henkilö sekä hänen diilinsä ja aikajanansa. |
create_person | Luo yhteystieto. |
add_note | Lisää muistiinpano diiliin, henkilölle tai yritykselle. |
list_tasks | Listaa avoimet tehtävät avaimen haltijalle (mine) tai kaikille. |
create_task | Luo tehtävä ja liitä se halutessasi diiliin, henkilöön tai yritykseen. |
get_task | Lue aktiviteetti ja sen revision-tunniste. |
update_task | Muokkaa aktiviteettia. |
get_activity_settings | Lue käytössä oleva aktiviteettien aikavyöhyke ja käytettävissä olevat aktiviteettityypit. |
complete_task | Merkitse tehtävä valmiiksi (tai avaa se uudelleen arvolla done=false). |
get_crm_capabilities | Tämän käyttäjän nykyiset CRM-ominaisuusoikeudet ja sallitut toiminnot. |
list_stages | Yhden myyntiputken vaiheet (oletusputki, jos jätetään pois), työtilan jäsenet ja valuutta. |
move_deals | Esikatsele tai toteuta enintään 100 avoimen diilin siirto. |
get_dashboard | Lue oma koontinäkymäsi ja käyttöoikeuksiesi mukaiset reaaliaikaiset tunnusluvut. |
save_dashboard | Tallenna oman koontinäkymäsi asettelu ja suodattimet työkalusta get_dashboard saadulla revision-arvolla. |
list_automations | Lue API-avaimeesi sidotut automaatiosäännöt ja viimeisimmät käytettävissä olevat ajotulokset. |
preview_automation | Validoi sääntö ja esikatsele täsmäävät avoimet diilit tekemättä muutoksia. |
save_automation | Luo sääntö tai muokkaa sitä esikatselusta saadulla vahvistuksella. |
simulate_automation | Aseta jonoon yksi simulointi täsmäävälle nykyiselle diilille. |
stop_automation | Kytke sääntö pois päältä ja peru sen odottavat ajot. |
archive_automation | Arkistoi sääntö ja peru sen odottavat ajot. |
cancel_automation_run | Peru odottava ajo. |
list_automation_notifications | Lue sisäiset automaatioilmoituksesi nykyisten diilioikeuksien mukaisesti. |
list_reports | Lue raporttityypit, laskentaperiaatteet, suodattimet ja omat tallennetut raportit (CRM Advanced -ylläpitäjä). |
run_report | Aja raportti nykyisillä tietueiden käyttöoikeuksilla. |
save_report | Tallenna henkilökohtaisen raportin määritys. |
list_views | Listaa luettavissa olevat tallennetut näkymät, kenttä- ja operaattorivalikoima sekä oletukset. |
query_records | Sivuta validoitu CRM-näkymä. |
preview_bulk_change | Esikatsele 1–100 valittua CRM-tietuetta. |
get_bulk_change | Lue massatoiminnon esikatselu ja seitsemän päivää säilyvät rivikohtaiset tulokset samalla API-avaimella. |
apply_bulk_change | Toteuta enintään viisi esikatseltua riviä atomisesti rivi kerrallaan. |
preview_import | Esikatsele enintään 100 CRM-riviä muuttamatta tietueita. |
get_import | Lue tuonnin esikatselu ja tallennettu eteneminen; erät vanhenevat seitsemän päivän kuluttua. |
apply_import | Toteuta enintään kymmenen esikatseltua riviä atomisesti rivi kerrallaan. |
save_view | Luo tai päivitä henkilökohtainen näkymä tai ylläpitäjänä työtilan näkymä (Advanced). |
get_card_layout | Lue jaetut korttiosiot, tietojen järjestys ja omien kenttien ryhmät. |
set_card_layout | Korvaa jaettu korttiasettelu ja omien kenttien ryhmät (CRM Advanced -ylläpitäjä). |
list_fields | Listaa omien kenttien määritykset, mukaan lukien arkistoidut kentät ja pysyvät vaihtoehdot. |
create_field | Luo oma kenttä (CRM Advanced -ylläpitäjä). |
update_field | Nimeä kenttä uudelleen, muuta sen järjestystä, ryhmittele tai arkistoi se (CRM Advanced -ylläpitäjä). |
set_field_rules | Esikatsele tai tallenna diilikenttien näkyvyys ja pakollisuus (CRM Advanced -ylläpitäjä). |
get_record_fields | Lue tietueen omat kentät, arvot ja revision-tunniste. |
set_record_fields | Päivitä omien kenttien arvot kentän tunnisteen perusteella. |
list_pipelines | Listaa työtilan myyntiputket, myös arkistoidut, sekä oletusmyyntiputki. |
create_pipeline | Luo myyntiputki neljällä aloitusvaiheella. |
update_pipeline | Nimeä myyntiputki uudelleen, muuta järjestystä, arkistoi se tai aseta se oletukseksi. |
set_stages | Korvaa myyntiputken aktiiviset vaiheet. |
activity | Työtilan rakenteinen tapahtumaloki, uusin ensin: luodut ja siirretyt, voitetut ja hävityt diilit, muistiinpanot, tehtävät sekä liitetyt ja luetut tarjoukset. |
list_proposals | Tarjoukset ja niiden lukutila: käynnit, kokonaislukuaika, luetaanko parhaillaan sekä liitetty diili. |
get_proposal | Yksi tarjous: sivukohtainen lukuaika, vastaanottajat, tapahtumat, versiot ja liitetty diili. |
list_visitors | Verkkosivustollasi vierailleet yritykset (Tiny Ant Visitors): nimetyt yritysverkot, katsotut sivut, viimeisin käynti ja mahdollisesti liitetty CRM-yritys sekä koti-, mobiili- ja datakeskusverkoista tulleiden käyntien määrä. |
link_proposal | Liitä olemassa oleva tarjous diiliin, jotta sen katselutiedot näkyvät diilin aikajanalla. |
Pyyntörajat ja kohtuukäyttö
MCP hyväksyy yhden JSON-RPC-viestin POST-pyyntöä kohden, kooltaan enintään 512 KiB. JSON-taulukot hylätään suorittamatta työkaluja. Lähetä pyynnöt erikseen. CRM:n muut kuin GET-pyynnöt, mukaan lukien tuonnit, massatoiminnot ja kyselyiden esikatselut, jakavat työtilakohtaisen 120 pyynnön minuuttikiintiön sovelluksen, REST-rajapinnan ja MCP:n kesken; ylityksestä palautuu 429 ja Retry-After. Nämä reunaverkon kiintiöt ovat Cloudflare-sijaintikohtaisia.
CRM:n kohtuukäytön tallennusrajat koskevat kutakin taulua erikseen (diilit, tehtävät ja muistiinpanot): Free 500, Pro 20 000 sekä Team ja Enterprise 50 000. Free-tasolla on lisäksi erillinen 10 avoimen diilin raja. Valmiit tehtävät ja suljetut diilit lasketaan mukaan tallennusrajoihin; olemassa olevat tietueet säilyvät, jos tasoa lasketaan.
Visitors vastaanottaa työtilaa ja UTC-päivää kohden enintään 5 000 sivunäyttöä Prossa, 20 000 Teamissa ja 50 000 Enterprisessa. Ylimenevä liikenne hylätään, ja keruu jatkuu seuraavana päivänä. Päiväraja käyttää yhteistä tietokantalaskuria; lisäksi reunaverkon suojaus rajoittaa lähdeosoitteen 60:een ja julkisen Visitors-avaimen 600 viestiin minuutissa Cloudflare-sijaintia kohden. Varauksen jälkeen epäonnistunut haku tai tallennus voi kuluttaa päiväkiintiötä. Asiakkaan oma ipapi.is-kiintiö on erillinen.
Kukin avain voi tehdä yhteensä 120 pyyntöä minuutissa REST-rajapintaan ja MCP-palvelimeen, ja kukin osoite 300 pyyntöä minuutissa. Ilman kelvollista avainta tehdyt pyynnöt on rajoitettu 30 pyyntöön minuutissa osoitetta kohden. Rajan ylittyessä saat vastauksen 429 ja Retry-After-otsakkeen; odota ja yritä uudelleen. Kysy muutoksia päätepisteestä /activity parametrilla since sen sijaan, että lukisit kokonaisia listoja uudelleen, käytä yhtä avainta integraatiota kohden, jotta voit tarvittaessa peruuttaa sen erikseen, äläkä jaa avainta työtilasi ulkopuolisille. Työtilassa voi olla enintään 10 aktiivista avainta.
CRM Advancedin automaatiosäännöt aloittavat simulointitilassa. Rajat ovat 50 aktiivista sääntöä ja 1 000 ajoa liukuvan 24 tunnin aikana työtilaa kohden. Diilin luonti ja vaiheen muutokset asetetaan jonoon atomisesti. Vahvistetut ulkoiset tarjouksen avaukset on rajoitettu yhteen tarjousta ja UTC-päivää kohden. Pysähtyneiden diilien määräajoissa on seitsemän päivän takautuva aikaikkuna. Ajot ja sisäiset ilmoitukset säilytetään 90 päivää. Asiakastietoja ei lähetetä tekoälymallille eikä ulkoiseen viestipalveluun.
CRM Advanced -ylläpitäjät voivat ajaa avoimen myyntiputken, voitettujen ja hävittyjen diilien sekä voittoprosentin, vaihehistorian, aktiviteettien ja painotetun ennusteen raportteja. Päivämäärävälit ovat sisältyviä UTC-päiviä (enintään 366); ajastetuissa aktiviteeteissa käytetään niiden omaa määräpäivää. Ennusteet perustuvat nykyisiin avoimiin diileihin ja vaiheiden todennäköisyyksiin, ja päiväämättömät diilit sekä eri valuutat pidetään erillään. Lähtötilanteen havainnot eivät ole historiallisia vaiheeseen siirtymisiä tai tunnettuja kestoja. Tallennetut henkilökohtaiset raportit tallentavat valinnat, eivät tulosten tilannekuvia. Jokainen ajo ja porautuminen noudattaa senhetkisiä tietueen käyttöoikeuksia.
CRM Advancedissa tietueiden käyttöoikeuksia sovelletaan sovelluksessa, REST-rajapinnassa, MCP:ssä ja vienneissä. API-avaimet ja webhookit koskevat oletuksena työtilan yhteisiä tietueita, mukaan lukien yhteiset päätietueet. Ylläpitäjä voi erikseen luoda integraation, joka kattaa kaikki työtilan tietueet myös yksityiset tietueet mukaan lukien. Laajuus näkyy Asetuksissa. Olemassa olevat rajoitukset jäävät voimaan, jos CRM Advanced -käyttöoikeus päättyy. Tarjousten julkiset vastaanottajalinkit toimivat edelleen erillisenä jakokanavana.
Webhookit
Jos haluat Tiny Antin kutsuvan omaa järjestelmääsi, lähtevät webhookit määritetään samalla Asetukset-sivulla. Ne lähettävät allekirjoitetun JSON-muotoisen POST-pyynnön, kun tarjous avataan, kun lukukerta päättyy, kun tila muuttuu sekä kun diili luodaan tai siirtyy vaiheesta toiseen.
Kysymyksiä
Kirjoita osoitteeseen hello@tinyant.io. Rajapinnan muutoksista ilmoitetaan tällä sivulla.