La configuració de Desenvolupador és on connectes Exayard amb el teu propi codi i amb aplicacions que creen altres empreses. Obre Configuració i després Desenvolupador. Només els administradors de l'empresa la veuen al menú de Configuració. Un membre que obre la pàgina la pot llegir, però no hi pot canviar res.
Les aplicacions, les claus d'API, els webhooks i els registres s'inclouen en tots els plans, també el gratuït. Només es cobra la feina d'IA.
Aplicacions
Una aplicació és una de les teves integracions, com ara "Pressupostador Acme" o "Sincronització nocturna". Cada clau d'API pertany a una aplicació. Aplicacions és la primera secció de la pàgina. Tots els membres la poden llegir. Només els administradors creen o modifiquen aplicacions.
Fes clic a Aplicació nova i omple'n el Nom, la Descripció, la Pàgina d'inici, el Correu electrònic d'assistència i els Àmbits. Els àmbits es divideixen en lectura i escriptura per a cada recurs, com ara read:projects i write:estimates. Les aplicacions no poden demanar l'àmbit admin:org. Una empresa pot tenir fins a 25 aplicacions.
Cada aplicació mostra quan es va crear i el seu límit de sol·licituds, com ara "Fins a 60 sol·licituds per minut per empresa i 600 en total". El menú Més accions de l'aplicació conté:
Edita canvia els detalls i els àmbits de l'aplicació.
Webhook defineix l'única adreça que rep els esdeveniments de totes les empreses que han instal·lat l'aplicació.
Suprimeix l'aplicació elimina l'aplicació i revoca totes les seves claus. Totes les empreses que l'havien instal·lada en perden l'accés.
Claus d'API
Una clau d'API permet que el teu propi codi cridi l'API d'Exayard. Les claus viuen dins d'una aplicació, a Claus. Una clau funciona a l'empresa de la seva aplicació, de manera que no cal passar cap ID d'empresa.
Per crear-ne una, fes clic a Clau nova a l'aplicació. Dona a la clau un Nom, com ara "Producció". A Àmbits, tria Tots per a tots els àmbits que té l'aplicació, o Específics per triar-ne menys. Defineix una data de Caducitat opcional si la clau és per a una feina de curta durada. La clau funciona fins al final d'aquell dia. Fes clic a Crea.
Exayard mostra la clau completa una sola vegada. Copia-la en aquell moment, perquè no es tornarà a mostrar mai més. Exayard només en conserva una còpia xifrada, de manera que una clau perduda no es pot recuperar. Crea'n una de nova i revoca l'antiga.
Una clau comença per exa_live_. Una clau creada en un entorn de proves comença per exa_test_. Després de crear-la, la clau mostra el seu nom, una vista prèvia com ara exa_live_...AbCd, i Darrer ús o Mai utilitzada. Una clau amb data de caducitat mostra Caducitat i la data, i una clau caducada mostra Caducada.
Una aplicació pot tenir fins a 25 claus actives. Una clau caducada continua comptant fins que la revoques. Per canviar de clau sense interrupcions, crea una segona clau, passa-hi els teus servidors i després revoca la primera.
Obre el menú Accions de la clau per canviar-ne el nom (Canvia el nom) o revocar-la (Revoca). La revocació no es pot desfer, i la clau deixa de funcionar en menys de 30 segons.
Si una clau apareix en un lloc públic, com ara un repositori de codi públic, Exayard la revoca, envia un correu electrònic als teus administradors i la manté a la llista marcada com a Trobada en públic, revocada.
Quan una altra empresa ha instal·lat la teva aplicació, el diàleg de clau nova també mostra Funciona a. Aquesta empresa és l'opció predeterminada. Totes les empreses que l'han instal·lat crea una clau que el teu servidor utilitza a cadascuna d'aquestes empreses. Aleshores, cada crida indica la seva empresa a la capçalera Exayard-Organization-Id.
Les mateixes claus connecten les eines sense codi. Consulta Connectar Exayard a Zapier, Connectar Exayard a Make i Connectar Exayard a n8n. Per als assistents d'IA, consulta Connectar Exa al teu assistent d'IA.
Claus antigues
Les claus creades abans que les claus visquessin dins de les aplicacions comencen per ak_. Continuen funcionant, però no se'n poden crear de noves. Apareixen a Claus antigues, a la part inferior de la pàgina, només mentre n'hi hagi.
Cada administrador hi veu totes les claus de l'empresa, independentment de qui les hagi creat. Una clau que ha creat una altra persona mostra Creada per i el seu nom. Cada persona també veu les seves pròpies claus personals. Fes clic a la icona de la paperera per revocar una clau (Revoca). Deixa de funcionar immediatament.
Entorns de proves
Un entorn de proves és una empresa de prova vinculada a la teva. Utilitza'l per crear i provar una integració sense tocar els teus projectes reals. Només els administradors veuen Entorns de proves.
Fes clic a Entorn de proves nou, dona-li un Nom i fes clic a Crea. Una empresa pot tenir fins a 5 entorns de proves. Obre et porta a l'entorn de proves, on el selector d'empreses el marca com a Entorn de proves. Crea-hi una aplicació i una clau com de costum. Les seves claus comencen per exa_test_. Per passar a producció, crea la mateixa aplicació i la mateixa clau a la teva empresa real i substitueix la clau al teu codi.
Un entorn de proves segueix el pla de la teva empresa, i la teva empresa paga el seu ús. No té facturació pròpia ni rep un ús mensual d'IA propi. Els webhooks i les integracions funcionen igual que a la teva empresa real.
Un entorn de proves no envia correus de compartició d'ofertes ni còpies signades a persones de fora, i no envia missatges de text. Apareixen com a "No s'ha enviat perquè aquesta empresa és un entorn de proves". Les invitacions per unir-se a l'entorn de proves s'envien com de costum.
Els amidaments i les lectures de fitxers en un entorn de proves retornen resultats copiats del nostre projecte d'exemple, sense cost. L'amidament, les seves pàgines i el webhook de finalització de l'amidament es marquen com a exemples. Els pressupostos, les ofertes, la cerca d'elements i el xat també responen amb exemples, sense cost.
Per eliminar un entorn de proves, fes clic a Suprimeix a la seva fila i després a Suprimeix l'entorn de proves. L'entorn de proves es tanca, les seves claus deixen de funcionar i les seves dades s'esborren més endavant.
Webhooks
Un webhook indica a Exayard que notifiqui el teu servidor quan passa alguna cosa a la teva empresa. Tots els membres poden llegir la llista. Només els administradors afegeixen o modifiquen webhooks.
Fes clic a Crea un webhook, introdueix l'URL que ha de rebre els enviaments i afegeix una Descripció opcional. Tria quins Esdeveniments vols enviar. Selecciona Tots per rebre tots els esdeveniments, inclosos els nous, o Específics per triar-los de la llista. Tots els esdeveniments i el seu contingut es detallen al catàleg d'esdeveniments de webhook.
Quan crees un webhook, Exayard en mostra el Secret de signatura una sola vegada. Copia'l en aquell moment, perquè no es tornarà a mostrar.
Obre el menú Més accions d'un webhook per a la resta:
Edita canvia l'URL, la descripció i els esdeveniments, i n'estableix l'Estat a Actiu o En pausa. Un webhook en pausa no rep cap enviament. El diàleg també té Renova el secret. El secret antic deixa de funcionar immediatament, així que actualitza primer el teu servidor.
Envia un esdeveniment de prova envia un esdeveniment del Tipus d'esdeveniment que triïs. El diàleg espera la resposta del teu servidor i mostra el resultat i el codi de resposta. Un esdeveniment de prova porta
"test": true.Enviaments mostra els darrers 25 enviaments amb el seu esdeveniment, estat, codi de resposta i nombre d'intents. Un enviament pot estar Pendent, Reintentant, Lliurat o Error. Els administradors poden fer clic a Torna a enviar per enviar de nou un enviament.
Suprimeix el webhook atura tots els enviaments a aquell URL.
Un esdeveniment de prova i un reenviament s'envien una sola vegada i no es reintenten mai.
Protegir els enviaments de webhook
Cada enviament porta una capçalera Exayard-Signature amb el format t=<unix>,v1=<digest>. Exayard construeix la signatura unint la marca de temps i el cos de la sol·licitud i, a continuació, els signa amb HMAC-SHA256 utilitzant el secret del teu webhook.
Cada enviament també porta les capçaleres Exayard-Event-Id, Exayard-Event-Type i Exayard-Organization-Id. El cos JSON té un camp organizationId que indica l'empresa d'on prové l'esdeveniment. La capçalera porta el mateix identificador, de manera que pots encaminar un enviament abans de llegir-ne el cos. La signatura cobreix tot el cos, inclòs organizationId.
Com que cada enviament indica la seva empresa, una sola adreça receptora pot donar servei a moltes empreses. Registra el mateix URL a cada empresa i encamina cada enviament segons organizationId. Cada webhook té el seu propi secret, així que tria el secret segons Exayard-Organization-Id abans de fer la verificació.
Per verificar un enviament, torna a calcular la signatura amb el teu secret, confirma que la marca de temps no s'allunya més de cinc minuts del moment actual i compara els resums.
Un enviament fallit s'intenta fins a 10 vegades en total, durant unes 80 hores, amb esperes cada vegada més llargues entre intents. Cada intent envia el mateix cos i el mateix ID d'esdeveniment. Una redirecció compta com a error.
Permetre que altres empreses instal·lin la teva aplicació
La teva aplicació funciona a la teva pròpia empresa tan bon punt la crees. Cada aplicació també té un apartat Permetre que altres empreses instal·lin aquesta aplicació. Mostra si l'aplicació està Revisada, amb Revisió sol·licitada o No revisada, les seves Adreces d'inici de sessió, el seu ID de client i quantes empreses la poden instal·lar.
Els administradors obren el menú Accions d'instal·lació per a aquestes opcions:
Edita les adreces d'inici de sessió defineix les adreces a què Exayard retorna les persones quan la teva aplicació inicia la seva sessió amb el seu compte d'Exayard. Introdueix una adreça per línia, fins a 10. Cadascuna ha de començar per
https://, o perhttp://localhostmentre fas proves. La primera vegada que desis adreces d'inici de sessió, Exayard mostra el Secret de client de l'aplicació una sola vegada.Copia l'enllaç d'instal·lació copia un enllaç que pots enviar a qualsevol empresa. Obre el diàleg d'instal·lació per a l'administrador d'aquella empresa.
Sol·licita una revisió envia l'aplicació a l'assistència d'Exayard perquè la revisi.
Una aplicació nova es pot instal·lar a un màxim de 25 empreses a més de la teva, i no apareix a Cerca aplicacions. Les empreses de Comptes per als teus clients no compten per a aquest límit. Un cop aprovada, l'aplicació mostra Revisada i el límit d'instal·lacions desapareix. Utilitza Mostra a Cerca aplicacions per incloure-la al directori de totes les empreses, o Amaga de Cerca aplicacions per treure-la'n. Una aplicació Suspesa no pot cridar Exayard fins que l'assistència aixequi la suspensió, i se'n conserven les instal·lacions.
Quan treus àmbits d'una aplicació, totes les instal·lacions els perden immediatament. Quan hi afegeixes àmbits, cada empresa conserva el seu accés actual fins que un dels seus administradors aprova els àmbits nous.
Webhook de l'aplicació
Obre el menú Més accions de l'aplicació i fes clic a Webhook. Introdueix l'URL i fes clic a Crea; després copia el Secret de signatura, que Exayard només mostra una vegada. Cada empresa que ha instal·lat l'aplicació envia els esdeveniments que cobreixen els àmbits concedits. La teva aplicació també rep app.installed, app.scopes_approved i app.uninstalled quan una empresa la instal·la, n'aprova un accés més ampli o l'elimina. Els enviaments indiquen la seva empresa i se signen de la mateixa manera que els altres webhooks.
El mateix diàleg et permet posar en pausa (Posa en pausa) i reprendre (Reprèn) els enviaments, Renova el secret i Suprimeix el webhook.
Aplicacions connectades
Aplicacions connectades mostra les aplicacions instal·lades a la teva empresa. Tots els membres la poden veure. Només els administradors instal·len, eliminen o aproven.
Cada fila mostra el nom de l'aplicació, si està Revisada, l'empresa que l'ha creada, qui la va instal·lar i quan, i els àmbits que se li van concedir.
Instal·lar una aplicació
Obre l'enllaç d'instal·lació de l'aplicació, o fes clic a Instal·la al costat de l'aplicació a Cerca aplicacions. El diàleg mostra qui ha creat l'aplicació, si està revisada i quins àmbits demana. Després tria:
Empresa: qualsevol empresa on siguis administrador. Una empresa que ja té l'aplicació apareix marcada com a (instal·lada). Si la tornes a instal·lar, es desen les teves noves opcions.
Projectes: Tots els projectes, o Només aquests projectes i marca els que l'aplicació pot consultar, fins a 500. L'aplicació no pot accedir a cap altre projecte de l'empresa.
Límit mensual d'IA: el màxim que pot costar a la teva empresa la feina d'IA de l'aplicació cada mes de facturació, en la teva moneda de facturació. Deixa-ho buit per a Sense límit.
Fes clic a Instal·la. Si l'aplicació inicia la teva sessió, Exayard et porta tot seguit a acabar d'iniciar la sessió a l'aplicació. Si ets membre però no administrador, el diàleg t'indica quin administrador de l'empresa la pot instal·lar. Fes clic a Copia l'enllaç per enviar-l'hi.
Per canviar els projectes més endavant, torna a obrir l'enllaç d'instal·lació i instal·la-la amb la nova opció.
Aprovar més accés
Quan una aplicació demana més àmbits, la seva fila mostra Demana més accés amb els àmbits nous. Un administrador fa clic a Aprova per concedir-los. Fins aleshores, l'aplicació conserva l'accés que tenia.
Eliminar una aplicació
Obre el menú Més accions de l'aplicació, fes clic a Elimina i confirma-ho. L'aplicació perd immediatament l'accés a la teva empresa i els seus webhooks s'aturen. La feina d'IA que ja havia iniciat s'acaba igualment.
Cerca aplicacions
Cerca aplicacions apareix dins d'Aplicacions connectades. Mostra les aplicacions revisades que els seus creadors han decidit publicar. Una aplicació que la teva empresa ja té mostra Instal·lada. Fes clic a Instal·la a qualsevol altra aplicació per obrir el diàleg d'instal·lació.
Les teves connexions personals
Les teves connexions personals mostra les eines d'IA i altres aplicacions que has connectat al teu propi compte d'Exayard, com ara ChatGPT o Claude. Apareix a la part superior d'Aplicacions connectades, i només tu veus les teves. Una connexió personal actua en nom teu, de manera que pot accedir a tot allò a què tu pots accedir.
Cada connexió mostra quan es va utilitzar per primera i per última vegada, i les empreses on s'ha utilitzat. Per aturar-ne una, obre el seu menú Més accions, fes clic a Elimina i confirma-ho. La seva següent crida es rebutja. La connexió es manté a la llista marcada com a Eliminada, i Torna a permetre li torna a donar accés. Per connectar una eina nova, consulta Connectar Exa al teu assistent d'IA.
Comptes per als teus clients
La teva aplicació pot crear empreses d'Exayard mitjançant l'API per a clients que només utilitzen Exayard a través del teu producte. La teva empresa és la propietària d'aquestes empreses i paga la feina d'IA que s'hi fa. No tenen membres propis, i les teves aplicacions s'hi instal·len automàticament.
Comptes per als teus clients les mostra als administradors, amb el Nom de cada empresa i la data en què es va crear (Creada). Fes clic a Dona de baixa i confirma-ho per tancar-ne una. Totes les aplicacions que hi ha en perden l'accés.
Primers passos
La targeta Inici ràpid conté una indicació preparada per a un editor d'IA com Claude o Cursor. Fes clic a Copia la indicació i enganxa-la al teu editor. La indicació inclou l'URL base de l'API, el format d'autenticació, els àmbits i l'esquema de signatura dels webhooks, de manera que la IA pot crear una integració funcional i demanar-te els detalls que necessiti. Només els administradors veuen aquesta targeta, perquè necessita una clau d'API.
La targeta Documentació enllaça amb la documentació completa per a desenvolupadors amb Obre la documentació, i amb l'Especificació OpenAPI, que descriu totes les rutes i esquemes. Els administradors també veuen Connecta amb Claude o Cursor, que obre la configuració per connectar assistents d'IA amb Exayard.
Registres
Registres mostra les sol·licituds fetes a l'API, de la més recent a la més antiga. Cada fila mostra el Mètode, la Ruta, l'Estat, l'Hora i la Latència. Fes clic a Carrega'n més a la part inferior per veure sol·licituds més antigues.
Els administradors veuen totes les sol·licituds. Els membres només veuen les sol·licituds que no han arribat a través d'una aplicació.
Els administradors poden filtrar per Aplicació i, després, per una de les claus d'aquella aplicació. Qualsevol persona pot escriure un Usuari final per veure només les sol·licituds d'aquell client. Un usuari final és el teu propi identificador per a un dels teus clients. El teu codi l'envia amb cada sol·licitud a la capçalera Exayard-End-User. No utilitzis mai una adreça de correu electrònic com a identificador.
Selecciona una fila per veure'n tot el detall, inclosos l'ID de la sol·licitud, l'aplicació i l'usuari final, i el Cos de la sol·licitud i el Cos de la resposta. Utilitza els registres per confirmar que una crida ha funcionat o per esbrinar per què falla una integració.
Despesa per clau i per usuari final
Els administradors veuen el que ha gastat cada aplicació aquest mes a Despesa per aplicació, a Configuració i després Ús. Les teves pròpies aplicacions també hi apareixen. A sota de cada aplicació, Per clau mostra el que ha gastat cada clau, i Principals usuaris finals mostra els cinc usuaris finals que més han gastat. La despesa que no està vinculada a cap clau de l'aplicació apareix com a Altres.
Límit mensual d'IA
El límit mensual d'IA d'una aplicació és el màxim que pot costar a la teva empresa la seva feina d'IA cada mes de facturació. Per definir-lo, obre el menú Més accions de l'aplicació a Despesa per aplicació i fes clic a Defineix el límit mensual d'IA. Introdueix un import en la teva moneda de facturació i fes clic a Desa. Desa el camp buit per eliminar el límit.
Quan l'aplicació arriba al seu límit, es rebutja la seva feina d'IA durant la resta del mes de facturació, encara que la teva empresa encara tingui ús d'IA disponible. Els límits propis de la teva empresa continuen aplicant-se. La feina d'IA que inicien les persones mateixes no compta mai per al límit d'una aplicació.
