Siirry pääsisältöön

Kehittäjäsovellukset, API-avaimet ja webhookit

Luo sovelluksia ja API-avaimia, testaa testiympäristössä, lähetä webhookeja, asenna muiden yritysten sovelluksia ja tarkastele pyyntölokeja sekä kulutusta avaimittain.

Tekijä: Sarah Chen

Kehittäjä-asetuksissa yhdistät Exayardin omaan koodiisi ja muiden yritysten rakentamiin sovelluksiin. Avaa Asetukset ja sitten Kehittäjä. Vain yrityksen ylläpitäjät näkevät sen Asetukset-valikossa. Jäsen, joka avaa sivun, voi lukea sitä mutta ei voi muuttaa mitään.

Sovellukset, API-avaimet, webhookit ja lokit sisältyvät jokaiseen tilaukseen, myös ilmaiseen. Vain tekoälytyöstä veloitetaan.

Sovellukset

Sovellus on yksi integraatioistasi, kuten "Acme-laskuri" tai "Yöllinen synkronointi". Jokainen API-avain kuuluu johonkin sovellukseen. Sovellukset on sivun ensimmäinen osio. Jokainen jäsen voi lukea sitä. Vain ylläpitäjät voivat luoda ja muuttaa sovelluksia.

Napsauta Uusi sovellus ja täytä kentät Nimi, Kuvaus, Kotisivu, Tuen sähköpostiosoite ja Käyttöoikeudet. Käyttöoikeudet on jaettu resurssikohtaisesti luku- ja kirjoitusoikeuksiin, kuten read:projects ja write:estimates. Sovellukset eivät voi pyytää admin:org-käyttöoikeutta. Yrityksellä voi olla enintään 25 sovellusta.

Jokaisesta sovelluksesta näkyy sen luontiaika ja pyyntöraja, esimerkiksi "Enintään 60 pyyntöä minuutissa yritystä kohden ja yhteensä 600". Sovelluksen Lisää toimintoja -valikossa on:

  • Muokkaa muuttaa sovelluksen tietoja ja käyttöoikeuksia.

  • Webhook asettaa yhden osoitteen, joka vastaanottaa tapahtumat jokaisesta sovelluksen asentaneesta yrityksestä.

  • Poista sovellus poistaa sovelluksen ja peruuttaa kaikki sen avaimet. Jokainen sen asentanut yritys menettää käyttöoikeuden.

API-avaimet

API-avain antaa oman koodisi kutsua Exayard-rajapintaa. Avaimet ovat sovelluksen sisällä kohdassa Avaimet. Avain toimii oman sovelluksensa yrityksessä, joten yrityksen tunnusta ei tarvitse välittää.

Luo avain napsauttamalla sovelluksessa Uusi avain. Anna avaimelle Nimi, kuten "Tuotanto". Valitse kohdassa Käyttöoikeudet Kaikki saadaksesi kaikki sovelluksen käyttöoikeudet tai Valitut valitaksesi niistä osan. Aseta tarvittaessa Vanhenee-päivämäärä, jos avain on lyhytaikaista työtä varten. Avain toimii kyseisen päivän loppuun asti. Napsauta Luo.

Exayard näyttää koko avaimen kerran. Kopioi se silloin, sillä sitä ei näytetä enää uudelleen. Exayard säilyttää vain salatun kopion, joten kadonnutta avainta ei voi palauttaa. Luo uusi avain ja peruuta vanha.

Avain alkaa exa_live_. Testiympäristössä luotu avain alkaa exa_test_. Luomisen jälkeen avaimesta näkyy sen nimi, esikatselu kuten exa_live_...AbCd sekä Viimeksi käytetty tai Ei koskaan käytetty. Avaimessa, jolla on vanhenemispäivä, näkyy Vanhenee ja päivämäärä, ja vanhentuneessa avaimessa näkyy Vanhentunut.

Sovelluksella voi olla enintään 25 aktiivista avainta. Vanhentunut avain lasketaan mukaan, kunnes peruutat sen. Jos haluat vaihtaa avaimet ilman katkosta, luo toinen avain, siirrä palvelimesi käyttämään sitä ja peruuta sitten ensimmäinen.

Avaa avaimen Avaimen toiminnot -valikko, jos haluat nimetä sen uudelleen (Nimeä uudelleen) tai peruuttaa sen (Peruuta käyttöoikeus). Peruutusta ei voi kumota, ja avain lakkaa toimimasta 30 sekunnin kuluessa.

Jos avain löytyy julkisesta paikasta, kuten julkisesta koodivarastosta, Exayard peruuttaa sen, lähettää ylläpitäjillesi sähköpostin ja säilyttää sen luettelossa merkinnällä Löytyi julkisesta lähteestä, mitätöity.

Kun toinen yritys on asentanut sovelluksesi, uuden avaimen ikkunassa näkyy myös Toimii. Oletuksena on Tässä yrityksessä. Kaikissa sen asentaneissa yrityksissä luo avaimen, jota palvelimesi käyttää jokaisessa näistä yrityksistä. Jokainen kutsu nimeää silloin yrityksensä Exayard-Organization-Id-otsakkeessa.

Samat avaimet yhdistävät myös koodittomat työkalut. Katso Exayardin yhdistäminen Zapieriin, Exayardin yhdistäminen Makeen ja Exayardin yhdistäminen n8n:ään. Tekoälyavustajia varten katso Exan yhdistäminen tekoälyavustajaasi.

Vanhat avaimet

Ennen sovelluskohtaisia avaimia luodut avaimet alkavat ak_. Ne toimivat edelleen, mutta uusia ei voi luoda. Ne näkyvät sivun alaosassa kohdassa Vanhat avaimet, mutta vain niin kauan kuin niitä on.

Jokainen ylläpitäjä näkee siellä kaikki yrityksen avaimet riippumatta siitä, kuka ne loi. Toisen henkilön luomassa avaimessa näkyy Tekijä ja hänen nimensä. Jokainen näkee myös omat henkilökohtaiset avaimensa. Peruuta avain roskakorikuvakkeen Peruuta käyttöoikeus -toiminnolla. Se lakkaa toimimasta välittömästi.

Testiympäristöt

Testiympäristö on yritykseesi linkitetty testiyritys. Sen avulla voit rakentaa ja testata integraation koskematta oikeisiin projekteihisi. Vain ylläpitäjät näkevät kohdan Testiympäristöt.

Napsauta Uusi testiympäristö, anna sille Nimi ja napsauta Luo. Yrityksellä voi olla enintään 5 testiympäristöä. Avaa siirtää sinut testiympäristöön, jolloin yrityksen vaihtaja merkitsee sen tekstillä Testiympäristö. Luo sinne sovellus ja avain tavalliseen tapaan. Sen avaimet alkavat exa_test_. Kun haluat siirtyä tuotantoon, luo sama sovellus ja avain oikeaan yritykseesi ja vaihda avain koodiisi.

Testiympäristö noudattaa yrityksesi tilausta, ja yrityksesi maksaa sen käytön. Sillä ei ole omaa laskutusta eikä omaa kuukausittaista tekoälyn käyttöä. Webhookit ja integraatiot toimivat samoin kuin oikeassa yrityksessäsi.

Testiympäristö ei lähetä tarjousten jakosähköposteja tai allekirjoitettuja kopioita sen ulkopuolisille henkilöille, eikä se lähetä tekstiviestejä. Ne näkyvät tekstillä "Ei lähetetty, koska tämä yritys on testiympäristö". Kutsut liittyä testiympäristöön lähetetään tavalliseen tapaan.

Testiympäristössä määrälaskelmat ja tiedostojen luvut palauttavat esimerkkiprojektistamme kopioidut tulokset maksutta. Määrälaskelma, sen sivut ja määrälaskelman valmistumisesta kertova webhook on merkitty esimerkeiksi. Myös kustannusarviot, tarjoukset, elementtihaku ja keskustelu vastaavat esimerkeillä maksutta.

Poista testiympäristö napsauttamalla sen rivillä Poista ja sitten Poista testiympäristö. Testiympäristö suljetaan, sen avaimet lakkaavat toimimasta ja sen tiedot poistetaan myöhemmin.

Webhookit

Webhook pyytää Exayardia ilmoittamaan palvelimellesi, kun yrityksessäsi tapahtuu jotain. Jokainen jäsen voi lukea luettelon. Vain ylläpitäjät voivat lisätä ja muuttaa webhookeja.

Napsauta Luo webhook, syötä URL, johon toimitukset lähetetään, ja lisää valinnainen Kuvaus. Valitse, mitkä Tapahtumat lähetetään. Valitse Kaikki vastaanottaaksesi kaikki tapahtumat, myös uudet, tai Valitut valitaksesi luettelosta. Jokainen tapahtuma ja sen sisältö on lueteltu webhook-tapahtumaluettelossa.

Kun luot webhookin, Exayard näyttää sen Allekirjoitussalaisuus-tiedon kerran. Kopioi se silloin, sillä sitä ei näytetä uudelleen.

Webhookin Lisää toimintoja -valikossa on muut toiminnot:

  • Muokkaa muuttaa URL-osoitetta, kuvausta ja tapahtumia ja asettaa kohdan Tila arvoksi Aktiivinen tai Keskeytetty. Keskeytetty webhook ei vastaanota toimituksia. Ikkunassa on myös Vaihda salaisuus. Vanha salaisuus lakkaa toimimasta välittömästi, joten päivitä palvelimesi ensin.

  • Lähetä testitapahtuma lähettää yhden valitsemasi Tapahtuman tyyppi -tapahtuman. Ikkuna odottaa palvelimesi vastausta ja näyttää tuloksen ja vastauskoodin. Testitapahtuma sisältää "test": true.

  • Toimitukset luettelee viimeiset 25 toimitusta sekä niiden tapahtuman, tilan, vastauskoodin ja yritysten määrän. Toimituksen tila on Odottaa, Yritetään uudelleen, Toimitettu tai Epäonnistui. Ylläpitäjät voivat lähettää toimituksen uudelleen napsauttamalla Lähetä uudelleen.

  • Poista webhook lopettaa kaikki toimitukset kyseiseen URL-osoitteeseen.

Testitapahtuma ja uudelleenlähetys lähetetään kerran, eikä niitä koskaan yritetä uudelleen.

Webhook-toimitusten suojaaminen

Jokainen toimitus sisältää Exayard-Signature-otsakkeen muodossa t=<unix>,v1=<digest>. Exayard muodostaa allekirjoituksen yhdistämällä aikaleiman ja pyynnön rungon ja allekirjoittamalla ne HMAC-SHA256-algoritmilla webhookisi salaisuutta käyttäen.

Jokainen toimitus sisältää myös otsakkeet Exayard-Event-Id, Exayard-Event-Type ja Exayard-Organization-Id. JSON-rungossa on organizationId-kenttä, joka nimeää yrityksen, josta tapahtuma on peräisin. Otsake sisältää saman tunnuksen, joten voit reitittää toimituksen ennen rungon lukemista. Allekirjoitus kattaa koko rungon, myös organizationId-kentän.

Koska jokainen toimitus nimeää yrityksensä, yksi vastaanotto-osoite voi palvella useita yrityksiä. Rekisteröi sama URL jokaiseen yritykseen ja reititä kukin toimitus organizationId-kentän perusteella. Jokaisella webhookilla on oma salaisuutensa, joten valitse salaisuus Exayard-Organization-Id-otsakkeen perusteella ennen tarkistusta.

Tarkista toimitus laskemalla allekirjoitus uudelleen salaisuudellasi, varmistamalla, että aikaleima on enintään viiden minuutin päässä nykyhetkestä, ja vertaamalla tiivisteitä.

Epäonnistunutta toimitusta yritetään yhteensä enintään 10 kertaa noin 80 tunnin aikana, ja yritysten väliset odotusajat pitenevät. Jokainen yritys lähettää saman rungon ja saman tapahtumatunnuksen. Uudelleenohjaus lasketaan epäonnistumiseksi.

Salli muiden yritysten asentaa sovelluksesi

Sovelluksesi toimii omassa yrityksessäsi heti, kun luot sen. Jokaisessa sovelluksessa on myös osio Salli muiden yritysten asentaa tämä sovellus. Siinä näkyy, onko sovellus Tarkistettu, Tarkistusta pyydetty vai Ei tarkistettu, sen Kirjautumisosoitteet, sen Asiakastunnus ja kuinka moneen yritykseen sen voi asentaa.

Ylläpitäjät avaavat Asennustoiminnot-valikon seuraavia varten:

  • Muokkaa kirjautumisosoitteita asettaa osoitteet, joihin Exayard palauttaa ihmiset, kun sovelluksesi kirjaa heidät sisään heidän Exayard-tilillään. Syötä yksi osoite riviä kohden, enintään 10. Jokaisen osoitteen on alettava https:// tai testauksen aikana http://localhost. Kun tallennat kirjautumisosoitteet ensimmäisen kerran, Exayard näyttää sovelluksen Asiakassalaisuus-tiedon kerran.

  • Kopioi asennuslinkki kopioi linkin, jonka voit lähettää mille tahansa yritykselle. Se avaa asennusikkunan kyseisen yrityksen ylläpitäjälle.

  • Pyydä tarkistusta lähettää sovelluksen Exayardin tuelle tarkistettavaksi.

Uuden sovelluksen voi asentaa enintään 25 yritykseen oman yrityksesi lisäksi, eikä se näy kohdassa Etsi sovelluksia. Kohdan Asiakkaidesi tilit yrityksiä ei lasketa tähän rajaan. Hyväksynnän jälkeen sovelluksessa näkyy Tarkistettu, ja asennusraja poistuu. Valitse Näytä Etsi sovelluksia -näkymässä listataksesi sovelluksen jokaisen yrityksen hakemistoon tai Piilota Etsi sovelluksia -näkymästä poistaaksesi sen sieltä. Jäädytetty sovellus ei voi kutsua Exayardia ennen kuin tuki poistaa jäädytyksen, ja sen asennukset säilyvät.

Kun poistat sovellukselta käyttöoikeuksia, jokainen asennus menettää ne välittömästi. Kun lisäät käyttöoikeuksia, jokainen yritys säilyttää nykyiset käyttöoikeutensa, kunnes joku sen ylläpitäjistä hyväksyy uudet käyttöoikeudet.

Sovelluksen webhook

Avaa sovelluksen Lisää toimintoja -valikko ja napsauta Webhook. Syötä URL ja napsauta Luo, ja kopioi sitten Allekirjoitussalaisuus, jonka Exayard näyttää vain kerran. Jokainen sovelluksen asentanut yritys lähettää ne tapahtumat, jotka sen myöntämät käyttöoikeudet kattavat. Sovelluksesi saa myös tapahtumat app.installed, app.scopes_approved ja app.uninstalled, kun yritys asentaa sen, hyväksyy laajemmat käyttöoikeudet tai poistaa sen. Toimitukset nimeävät yrityksensä, ja ne allekirjoitetaan samalla tavalla kuin muut webhookit.

Samassa ikkunassa voit keskeyttää toimitukset (Keskeytä) ja jatkaa niitä (Jatka), vaihtaa salaisuuden (Vaihda salaisuus) ja poistaa webhookin (Poista webhook).

Yhdistetyt sovellukset

Yhdistetyt sovellukset luettelee yritykseesi asennetut sovellukset. Jokainen jäsen näkee sen. Vain ylläpitäjät voivat asentaa, poistaa ja hyväksyä sovelluksia.

Jokaisella rivillä näkyy sovelluksen nimi, onko se Tarkistettu, sen rakentanut yritys, kuka sen asensi ja milloin sekä sille myönnetyt käyttöoikeudet.

Sovelluksen asentaminen

Avaa sovelluksen asennuslinkki tai napsauta sen vieressä olevaa Asenna-painiketta kohdassa Etsi sovelluksia. Ikkunassa näkyy, kuka sovelluksen rakensi, onko se tarkistettu ja mitä käyttöoikeuksia se pyytää. Valitse sitten:

  • Yritys: mikä tahansa yritys, jossa olet ylläpitäjä. Yritys, jolla sovellus jo on, on merkitty tekstillä (asennettu). Uudelleen asentaminen tallentaa uudet valintasi.

  • Projektit: Kaikki projektit tai Vain nämä projektit, jolloin rastitat projektit, joihin sovellus pääsee, enintään 500. Sovellus ei pääse yrityksen muihin projekteihin.

  • Tekoälyn kuukausiraja: enimmäissumma, jonka sovelluksen tekoälytyö saa maksaa yrityksellesi kunakin laskutuskuukautena, laskutusvaluutassasi. Jätä kenttä tyhjäksi, jos haluat valita Ei rajaa.

Napsauta Asenna. Jos sovellus kirjaa sinut sisään, Exayard ohjaa sinut seuraavaksi viimeistelemään sovellukseen kirjautumisen. Jos olet jäsen mutta et ylläpitäjä, ikkuna kertoo, minkä yrityksen ylläpitäjä voi asentaa sovelluksen. Napsauta Kopioi linkki lähettääksesi sen hänelle.

Jos haluat myöhemmin muuttaa projekteja, avaa asennuslinkki uudelleen ja asenna sovellus uudella valinnalla.

Laajempien käyttöoikeuksien hyväksyminen

Kun sovellus pyytää lisää käyttöoikeuksia, sen rivillä näkyy Pyytää laajempia käyttöoikeuksia sekä uudet käyttöoikeudet. Ylläpitäjä myöntää ne napsauttamalla Hyväksy. Siihen asti sovellus säilyttää aiemmat käyttöoikeutensa.

Sovelluksen poistaminen

Avaa sovelluksen Lisää toimintoja -valikko, napsauta Poista ja vahvista. Sovellus menettää välittömästi pääsyn yritykseesi, ja sen webhookit lakkaavat toimimasta. Sen jo käynnistämä tekoälytyö viedään silti loppuun.

Etsi sovelluksia

Etsi sovelluksia näkyy kohdan Yhdistetyt sovellukset sisällä. Se luettelee tarkistetut sovellukset, jotka niiden rakentajat ovat päättäneet listata. Sovelluksessa, joka yritykselläsi jo on, näkyy Asennettu. Napsauta minkä tahansa muun sovelluksen kohdalla Asenna avataksesi asennusikkunan.

Henkilökohtaiset yhteytesi

Henkilökohtaiset yhteytesi luettelee tekoälytyökalut ja muut sovellukset, jotka olet yhdistänyt omaan Exayard-tiliisi, kuten ChatGPT:n tai Clauden. Se näkyy kohdan Yhdistetyt sovellukset yläosassa, ja vain sinä näet omat yhteytesi. Henkilökohtainen yhteys toimii sinun nimissäsi, joten se pääsee kaikkeen, mihin sinäkin pääset.

Jokaisesta yhteydestä näkyy, milloin sitä käytettiin ensimmäisen ja viimeisen kerran, sekä yritykset, joissa sitä käytettiin. Lopeta yhteys avaamalla sen Lisää toimintoja -valikko, napsauttamalla Poista ja vahvistamalla. Sen seuraava kutsu estetään. Yhteys jää luetteloon merkinnällä Poistettu, ja Salli uudelleen päästää sen takaisin. Uuden työkalun yhdistämisestä kerrotaan artikkelissa Exan yhdistäminen tekoälyavustajaasi.

Asiakkaidesi tilit

Sovelluksesi voi luoda rajapinnan kautta Exayard-yrityksiä asiakkaille, jotka käyttävät Exayardia vain tuotteesi kautta. Yrityksesi omistaa nämä yritykset ja maksaa niissä tehdyn tekoälytyön. Niillä ei ole omia jäseniä, ja sovelluksesi asennetaan niihin automaattisesti.

Asiakkaidesi tilit luettelee ne ylläpitäjille, ja jokaisesta yrityksestä näkyy Nimi ja Luotu-päivämäärä. Sulje yritys napsauttamalla Luovu ja vahvistamalla. Jokainen yrityksen sovellus menettää pääsynsä.

Aloita

Pika-aloitus-kortilla on valmis kehote tekoälyeditorille, kuten Claudelle tai Cursorille. Napsauta Kopioi kehote ja liitä se editoriisi. Kehote sisältää rajapinnan perus-URL-osoitteen, todennusmuodon, käyttöoikeudet ja webhookien allekirjoitusmenetelmän, joten tekoäly voi rakentaa toimivan integraation ja kysyä sinulta tarvitsemiaan tietoja. Vain ylläpitäjät näkevät tämän kortin, koska se tarvitsee API-avaimen.

Dokumentaatio-kortilla on linkki kattavaan kehittäjädokumentaatioon (Avaa dokumentaatio) sekä OpenAPI-määritys, joka kuvaa jokaisen reitin ja skeeman. Ylläpitäjät näkevät myös kohdan Yhdistä Claudeen tai Cursoriin, joka avaa asetukset tekoälyavustajien yhdistämiseksi Exayardiin.

Lokit

Lokit näyttää rajapintaan tehdyt pyynnöt uusimmasta alkaen. Jokaisella rivillä näkyvät Metodi, Polku, Tila, Aika ja Viive. Napsauta alaosassa Lataa lisää nähdäksesi vanhempia pyyntöjä.

Ylläpitäjät näkevät kaikki pyynnöt. Jäsenet näkevät vain pyynnöt, jotka eivät tulleet sovelluksen kautta.

Ylläpitäjät voivat suodattaa kohdan Sovellus mukaan ja sitten jonkin kyseisen sovelluksen avaimen mukaan. Kuka tahansa voi kirjoittaa kenttään Loppukäyttäjä nähdäkseen vain kyseisen asiakkaan pyynnöt. Loppukäyttäjä on oma tunnuksesi jollekin asiakkaallesi. Koodisi lähettää sen jokaisen pyynnön mukana Exayard-End-User-otsakkeessa. Älä koskaan käytä sähköpostiosoitetta tunnuksena.

Valitse rivi nähdäksesi sen kaikki tiedot, mukaan lukien Pyynnön tunnus, sovellus ja loppukäyttäjä sekä Pyynnön runko ja Vastauksen runko. Lokien avulla voit varmistaa, että kutsu onnistui, tai selvittää, miksi integraatio ei toimi.

Kulutus avaimittain ja loppukäyttäjittäin

Ylläpitäjät näkevät, paljonko kukin sovellus on kuluttanut tässä kuussa, kohdassa Kulutus sovelluksittain, kun avaat Asetukset ja sitten Käyttö. Myös omat sovelluksesi näkyvät siellä. Kunkin sovelluksen alla Avaimittain näyttää, paljonko kukin avain on kuluttanut, ja Suurimmat loppukäyttäjät näyttää viisi eniten kuluttanutta loppukäyttäjää. Kulutus, joka ei liity mihinkään sovelluksen avaimista, näkyy kohtana Muu.

Tekoälyn kuukausiraja

Sovelluksen tekoälyn kuukausiraja on enimmäissumma, jonka sen tekoälytyö saa maksaa yrityksellesi kunakin laskutuskuukautena. Aseta raja avaamalla sovelluksen Lisää toimintoja -valikko kohdassa Kulutus sovelluksittain ja napsauttamalla Aseta tekoälyn kuukausiraja. Syötä summa laskutusvaluutassasi ja napsauta Tallenna. Tallenna tyhjä kenttä poistaaksesi rajan.

Kun sovellus saavuttaa rajansa, sen tekoälytyö estetään laskutuskuukauden loppuun asti, vaikka yritykselläsi olisi vielä tekoälyn käyttöä jäljellä. Yrityksesi omat rajat ovat edelleen voimassa. Ihmisten itse käynnistämää tekoälytyötä ei koskaan lasketa sovelluksen rajaan.

Vastasiko tämä kysymykseesi?