Direct la conținutul principal

Aplicații pentru dezvoltatori, chei API și webhookuri

Creați aplicații și chei API, testați într-un sandbox, trimiteți webhookuri, instalați aplicațiile altor companii și consultați jurnalele de solicitări și cheltuielile pe cheie.

Scris de Sarah Chen

Setările Dezvoltator sunt locul în care conectați Exayard la propriul cod și la aplicațiile construite de alte companii. Deschideți Setări, apoi Dezvoltator. Doar administratorii companiei văd această opțiune în meniul Setări. Un membru care deschide pagina o poate citi, dar nu poate modifica nimic.

Aplicațiile, cheile API, webhookurile și jurnalele sunt incluse în fiecare plan, inclusiv în planul Free. Se taxează doar activitatea AI.

Aplicații

O aplicație este una dintre integrările dvs., de exemplu „Acme estimator” sau „Nightly sync”. Fiecare cheie API aparține unei aplicații. Aplicații este prima secțiune de pe pagină. Fiecare membru o poate citi. Doar administratorii creează sau modifică aplicații.

Faceți clic pe Aplicație nouă și completați Nume, Descriere, Pagină principală, E-mail de asistență și Permisiuni. Permisiunile sunt împărțite în citire și scriere pentru fiecare resursă, de exemplu read:projects și write:estimates. Aplicațiile nu pot solicita permisiunea admin:org. O companie poate avea până la 25 de aplicații.

Fiecare aplicație arată când a fost creată și limita sa de solicitări, de exemplu „Până la 60 de solicitări pe minut per companie și 600 în total”. Meniul Mai multe acțiuni al aplicației conține:

  • Editează modifică detaliile și permisiunile aplicației.

  • Webhook setează singura adresă care primește evenimente de la fiecare companie care a instalat aplicația.

  • Șterge aplicația elimină aplicația și revocă toate cheile sale. Fiecare companie care a instalat-o pierde accesul.

Chei API

O cheie API permite propriului cod să apeleze API-ul Exayard. Cheile se află în interiorul unei aplicații, la Chei. O cheie funcționează în compania aplicației sale, așa că nu este nevoie să transmiteți un ID de companie.

Pentru a crea una, faceți clic pe Cheie nouă în aplicație. Dați cheii un Nume, de exemplu „Production”. La Permisiuni, alegeți Toate pentru toate permisiunile pe care le are aplicația sau Anumite pentru a alege mai puține. Setați, opțional, o dată la Expiră dacă cheia este pentru o activitate de scurtă durată. Cheia funcționează până la sfârșitul acelei zile. Faceți clic pe Creează.

Exayard afișează cheia completă o singură dată. Copiați-o atunci, deoarece nu va mai fi afișată niciodată. Exayard păstrează doar o copie criptată, așa că o cheie pierdută nu poate fi recuperată. Creați una nouă și revocați-o pe cea veche.

O cheie începe cu exa_live_. O cheie creată într-un sandbox începe cu exa_test_. După ce o creați, cheia își afișează numele, o previzualizare precum exa_live_...AbCd și Ultima utilizare sau Nefolosită. O cheie cu dată de expirare afișează Expiră și data respectivă, iar o cheie expirată afișează Expirată.

O aplicație poate avea până la 25 de chei active. O cheie expirată se ia în calcul până când o revocați. Pentru a schimba cheile fără întrerupere, creați o a doua cheie, mutați serverele pe ea, apoi revocați-o pe prima.

Deschideți meniul Acțiuni pentru cheie al unei chei pentru a folosi Redenumește sau Revocă. Revocarea nu poate fi anulată, iar cheia nu mai funcționează în cel mult 30 de secunde.

Dacă o cheie apare într-un loc public, de exemplu într-un depozit public de cod, Exayard o revocă, trimite un e-mail administratorilor dvs. și o păstrează în listă marcată Găsită în spațiul public, revocată.

Când o altă companie a instalat aplicația dvs., fereastra pentru cheie nouă afișează și Funcționează în. Această companie este opțiunea implicită. Toate companiile care au instalat-o creează o cheie pe care serverul dvs. o folosește în fiecare dintre acele companii. Fiecare apel își indică apoi compania în antetul Exayard-Organization-Id.

Aceleași chei conectează și instrumentele fără cod. Consultați Conectarea Exayard la Zapier, Conectarea Exayard la Make și Conectarea Exayard la n8n. Pentru asistenții AI, consultați Conectarea lui Exa la asistentul dvs. AI.

Chei vechi

Cheile create înainte ca acestea să fie grupate în aplicații încep cu ak_. Ele funcționează în continuare, dar nu se mai pot crea chei noi de acest tip. Apar la Chei vechi, în partea de jos a paginii, doar cât timp există.

Fiecare administrator vede acolo toate cheile companiei, indiferent cine le-a creat. O cheie creată de altcineva afișează Creată de și numele persoanei. Fiecare persoană își vede și propriile chei personale. Faceți clic pe pictograma coș de gunoi pentru a folosi Revocă. Cheia nu mai funcționează imediat.

Sandboxuri

Un sandbox este o companie de test legată de a dvs. Folosiți-l pentru a construi și testa o integrare fără a atinge proiectele reale. Doar administratorii văd Sandboxuri.

Faceți clic pe Sandbox nou, dați-i un Nume și faceți clic pe Creează. O companie poate avea până la 5 sandboxuri. Deschideți vă mută în sandbox, unde selectorul de companii îl marchează cu Sandbox. Creați acolo o aplicație și o cheie, ca de obicei. Cheile sale încep cu exa_test_. Pentru a trece în producție, creați aceeași aplicație și aceeași cheie în compania reală și înlocuiți cheia în codul dvs.

Un sandbox urmează planul companiei dvs., iar compania dvs. plătește utilizarea sa. Nu are facturare proprie și nu primește o utilizare AI lunară proprie. Webhookurile și integrările funcționează la fel ca în compania reală.

Un sandbox nu trimite e-mailuri de partajare a ofertelor sau copii semnate către persoane din afara sa și nu trimite mesaje text. Acestea apar ca „Netrimis deoarece această companie este un sandbox”. Invitațiile de alăturare la sandbox sunt trimise ca de obicei.

Antemăsurătorile și citirile de fișiere dintr-un sandbox returnează rezultate copiate din proiectul nostru demonstrativ, fără cost. Antemăsurătoarea, paginile sale și webhookul de finalizare a antemăsurătorii sunt marcate ca exemple. Devizele, ofertele, căutarea de elemente și chatul răspund tot cu exemple, fără cost.

Pentru a elimina un sandbox, faceți clic pe Ștergeți pe rândul său, apoi pe Ștergeți sandboxul. Sandboxul este închis, cheile sale nu mai funcționează, iar datele sale sunt șterse ulterior.

Webhookuri

Un webhook îi indică lui Exayard să vă anunțe serverul atunci când se întâmplă ceva în compania dvs. Fiecare membru poate citi lista. Doar administratorii adaugă sau modifică webhookuri.

Faceți clic pe Creează webhook, introduceți URL care trebuie să primească livrările și adăugați, opțional, o Descriere. Alegeți ce Evenimente se trimit. Selectați Toate pentru a primi toate evenimentele, inclusiv pe cele noi, sau Anumite pentru a alege din listă. Fiecare eveniment și conținutul său sunt enumerate în catalogul de evenimente webhook.

Când creați un webhook, Exayard afișează o singură dată Secret de semnare. Copiați-l atunci, deoarece nu va mai fi afișat.

Deschideți meniul Mai multe acțiuni al unui webhook pentru restul opțiunilor:

  • Editează modifică URL-ul, descrierea și evenimentele și setează Stare la Activ sau Întrerupt. Un webhook întrerupt nu primește livrări. Fereastra de dialog are și Regenerează secretul. Secretul vechi nu mai funcționează imediat, așa că actualizați-vă mai întâi serverul.

  • Trimiteți un eveniment de test trimite un eveniment de tipul ales la Tip de eveniment. Fereastra de dialog așteaptă răspunsul serverului dvs. și afișează rezultatul și codul de răspuns. Un eveniment de test conține "test": true.

  • Livrări listează ultimele 25 de livrări, cu evenimentul, starea, codul de răspuns și numărul de încercări. O livrare este În așteptare, Se reîncearcă, Livrat sau Eșuat. Administratorii pot face clic pe Retrimiteți pentru a trimite din nou o livrare.

  • Ștergeți webhookul oprește toate livrările către acel URL.

Un eveniment de test și o retrimitere sunt trimise o singură dată și nu sunt niciodată reîncercate.

Securizarea livrărilor webhook

Fiecare livrare conține un antet Exayard-Signature în formatul t=<unix>,v1=<digest>. Exayard construiește semnătura prin alăturarea marcajului de timp și a corpului solicitării, apoi le semnează cu HMAC-SHA256 folosind secretul webhookului dvs.

Fiecare livrare conține, de asemenea, antetele Exayard-Event-Id, Exayard-Event-Type și Exayard-Organization-Id. Corpul JSON are un câmp organizationId care indică compania de la care provine evenimentul. Antetul conține același ID, astfel încât puteți direcționa o livrare înainte de a citi corpul. Semnătura acoperă întregul corp, inclusiv organizationId.

Deoarece fiecare livrare își indică compania, o singură adresă de recepție poate deservi mai multe companii. Înregistrați același URL în fiecare companie și direcționați fiecare livrare după organizationId. Fiecare webhook are propriul secret, așa că alegeți secretul după Exayard-Organization-Id înainte de verificare.

Pentru a verifica o livrare, recalculați semnătura cu secretul dvs., confirmați că marcajul de timp se încadrează în cinci minute față de momentul actual și comparați valorile digest.

O livrare eșuată este încercată de până la 10 ori în total, pe parcursul a aproximativ 80 de ore, cu pauze din ce în ce mai lungi între încercări. Fiecare încercare trimite același corp și același ID de eveniment. O redirecționare este considerată eșec.

Permiteți altor companii să vă instaleze aplicația

Aplicația dvs. funcționează în propria companie imediat ce o creați. Fiecare aplicație are și o secțiune Permite altor companii să instaleze această aplicație. Aceasta arată dacă aplicația este Verificată, Verificare solicitată sau Neverificată, Adrese de conectare, ID client și câte companii o pot instala.

Administratorii deschid meniul Acțiuni de instalare pentru următoarele:

  • Editează adresele de conectare setează adresele la care Exayard trimite înapoi persoanele atunci când aplicația dvs. le autentifică cu contul lor Exayard. Introduceți câte o adresă pe fiecare rând, până la 10. Fiecare trebuie să înceapă cu https:// sau cu http://localhost cât timp testați. Prima dată când salvați adrese de conectare, Exayard afișează o singură dată Secret client al aplicației.

  • Copiază linkul de instalare copiază un link pe care îl puteți trimite oricărei companii. Acesta deschide fereastra de instalare pentru administratorul acelei companii.

  • Solicită verificarea trimite aplicația echipei de asistență Exayard pentru verificare.

O aplicație nouă poate fi instalată în până la 25 de companii pe lângă a dvs. și nu apare în Găsește aplicații. Companiile de la Conturi pentru clienții dvs. nu se iau în calcul în această limită. După aprobare, aplicația afișează Verificată, iar limita de instalări este eliminată. Folosiți Afișează în Găsește aplicații pentru a o lista în directorul fiecărei companii sau Ascunde din Găsește aplicații pentru a o retrage. O aplicație Suspendată nu poate apela Exayard până când echipa de asistență ridică suspendarea, iar instalările sale sunt păstrate.

Când eliminați permisiuni dintr-o aplicație, fiecare instalare le pierde imediat. Când adăugați permisiuni, fiecare companie își păstrează accesul actual până când unul dintre administratorii săi aprobă noile permisiuni.

Webhookul aplicației

Deschideți meniul Mai multe acțiuni al aplicației și faceți clic pe Webhook. Introduceți URL și faceți clic pe Creează, apoi copiați Secret de semnare, pe care Exayard îl afișează o singură dată. Fiecare companie care a instalat aplicația trimite evenimentele acoperite de permisiunile acordate. Aplicația dvs. primește, de asemenea, app.installed, app.scopes_approved și app.uninstalled atunci când o companie o instalează, aprobă un acces extins sau o elimină. Livrările își indică compania și sunt semnate la fel ca celelalte webhookuri.

Aceeași fereastră de dialog vă permite să folosiți Întrerupe și Reia pentru livrări, Regenerează secretul și Ștergeți webhookul.

Aplicații conectate

Aplicații conectate listează aplicațiile instalate în compania dvs. Fiecare membru o poate vedea. Doar administratorii instalează, elimină sau aprobă.

Fiecare rând afișează numele aplicației, dacă este Verificată, compania care a construit-o, cine a instalat-o și când, precum și permisiunile acordate.

Instalarea unei aplicații

Deschideți linkul de instalare al aplicației sau faceți clic pe Instalează lângă aceasta în Găsește aplicații. Fereastra de dialog arată cine a construit aplicația, dacă este verificată și ce permisiuni solicită. Apoi alegeți:

  • Companie: orice companie în care sunteți administrator. O companie care are deja aplicația este marcată (instalată). O nouă instalare vă salvează noile opțiuni.

  • Proiecte: Toate proiectele sau Doar aceste proiecte, bifând proiectele pe care aplicația le poate accesa, până la 500. Aplicația nu poate accesa niciun alt proiect din companie.

  • Limită lunară AI: suma maximă pe care activitatea AI a aplicației o poate costa compania dvs. în fiecare lună de facturare, în moneda dvs. de facturare. Lăsați câmpul gol pentru Fără limită.

Faceți clic pe Instalează. Dacă aplicația vă autentifică, Exayard vă duce apoi mai departe pentru a finaliza autentificarea în aplicație. Dacă sunteți membru, dar nu administrator, fereastra de dialog vă spune administratorul cărei companii o poate instala. Faceți clic pe Copiază linkul pentru a i-l trimite.

Pentru a modifica ulterior proiectele, deschideți din nou linkul de instalare și instalați cu noua opțiune.

Aprobarea unui acces extins

Când o aplicație solicită permisiuni suplimentare, rândul său afișează Solicită acces extins împreună cu noile permisiuni. Un administrator face clic pe Aprobă pentru a le acorda. Până atunci, aplicația își păstrează accesul pe care îl avea.

Eliminarea unei aplicații

Deschideți meniul Mai multe acțiuni al aplicației, faceți clic pe Elimină și confirmați. Aplicația pierde imediat accesul la compania dvs., iar webhookurile sale se opresc. Activitatea AI pe care o pornise deja se finalizează totuși.

Găsește aplicații

Găsește aplicații apare în Aplicații conectate. Listează aplicațiile verificate pe care creatorii lor au ales să le listeze. O aplicație pe care compania dvs. o are deja afișează Instalată. Faceți clic pe Instalează la orice altă aplicație pentru a deschide fereastra de instalare.

Conexiunile dvs. personale

Conexiunile dvs. personale listează instrumentele AI și celelalte aplicații pe care le-ați conectat la propriul cont Exayard, precum ChatGPT sau Claude. Secțiunea apare în partea de sus a Aplicații conectate și doar dvs. vă vedeți propriile conexiuni. O conexiune personală acționează în numele dvs., așa că poate accesa tot ce puteți accesa și dvs.

Fiecare conexiune arată când a fost folosită prima și ultima dată, precum și companiile în care a fost folosită. Pentru a opri una, deschideți meniul Mai multe acțiuni al acesteia, faceți clic pe Elimină și confirmați. Următorul său apel este refuzat. Conexiunea rămâne în listă marcată Eliminată, iar Permite din nou îi redă accesul. Pentru a conecta un instrument nou, consultați Conectarea lui Exa la asistentul dvs. AI.

Conturi pentru clienții dvs.

Aplicația dvs. poate crea companii Exayard prin API pentru clienții care folosesc Exayard doar prin produsul dvs. Compania dvs. deține aceste companii și plătește activitatea AI efectuată în ele. Ele nu au membri proprii, iar aplicațiile dvs. sunt instalate automat în ele.

Conturi pentru clienții dvs. le listează pentru administratori, cu Nume pentru fiecare companie și data din Creată. Faceți clic pe Renunță și confirmați pentru a închide una. Fiecare aplicație din compania respectivă pierde accesul.

Primii pași

Cardul Pornire rapidă conține un prompt gata pregătit pentru un editor AI precum Claude sau Cursor. Faceți clic pe Copiați promptul și lipiți-l în editor. Promptul include URL-ul de bază al API-ului, formatul de autentificare, permisiunile și schema de semnare a webhookurilor, astfel încât AI-ul poate construi o integrare funcțională și vă poate solicita detaliile de care are nevoie. Doar administratorii văd acest card, deoarece necesită o cheie API.

Cardul Documentație trimite către documentația completă pentru dezvoltatori prin Deschideți documentația și către Specificație OpenAPI, care descrie fiecare rută și fiecare schemă. Administratorii văd și Conectează-te la Claude sau Cursor, care deschide configurarea pentru conectarea asistenților AI la Exayard.

Jurnale

Jurnale afișează solicitările făcute către API, de la cele mai noi. Fiecare rând afișează Metodă, Cale, Stare, Oră și Latență. Faceți clic pe Încarcă mai multe în partea de jos pentru a vedea solicitări mai vechi.

Administratorii văd toate solicitările. Membrii văd doar solicitările care nu au venit printr-o aplicație.

Administratorii pot filtra după Aplicație și apoi după una dintre cheile acelei aplicații. Oricine poate introduce un Utilizator final pentru a vedea doar solicitările acelui client. Un utilizator final este ID-ul dvs. propriu pentru unul dintre clienții dvs. Codul dvs. îl trimite cu fiecare solicitare în antetul Exayard-End-User. Nu folosiți niciodată o adresă de e-mail ca ID.

Selectați un rând pentru a vedea toate detaliile, inclusiv ID solicitare, aplicația și utilizatorul final, precum și Corpul solicitării și Corpul răspunsului. Folosiți jurnalele pentru a confirma că un apel a funcționat sau pentru a afla de ce nu funcționează o integrare.

Cheltuieli pe cheie și pe utilizator final

Administratorii văd cât a cheltuit fiecare aplicație luna aceasta la Cheltuieli pe aplicație în Setări, apoi Utilizare. Propriile dvs. aplicații sunt listate și ele acolo. Sub fiecare aplicație, După cheie arată cât a cheltuit fiecare cheie, iar Principalii utilizatori finali arată cei cinci utilizatori finali care au cheltuit cel mai mult. Cheltuielile care nu sunt legate de una dintre cheile aplicației apar ca Altele.

Limita lunară AI

Limita lunară AI a unei aplicații este suma maximă pe care activitatea sa AI o poate costa compania dvs. în fiecare lună de facturare. Pentru a o seta, deschideți meniul Mai multe acțiuni al aplicației la Cheltuieli pe aplicație și faceți clic pe Setează limita lunară AI. Introduceți o sumă în moneda dvs. de facturare și faceți clic pe Salvează. Salvați un câmp gol pentru a elimina limita.

Când aplicația își atinge limita, activitatea sa AI este refuzată până la sfârșitul lunii de facturare, chiar dacă compania dvs. mai are utilizare AI disponibilă. Limitele proprii ale companiei dvs. se aplică în continuare. Activitatea AI pornită chiar de utilizatori nu este niciodată luată în calcul în limita unei aplicații.

Ați primit răspuns la întrebare?