API och webhooks
Publicerat av Resly AB
API-nycklar och behörigheter
Ge ert system åtkomst genom en nyckel kopplad till rätt användare och ärendebehörigheter.
API-nycklar
Administratörer skapar API-nycklar på utvecklarsidan. Ange namn, välj en ansluten användare och bestäm standardåtkomst för ärenden som integrationen skapar. Nyckeln använder den valda användarens behörigheter.
Det hemliga nyckelvärdet visas efter skapandet. Kopiera och spara det för integrationen innan du stänger dialogen, eftersom det inte kan hämtas från den vanliga listan senare. API-nycklar kan inte skapas i demosandlådan.
Mer om api-nycklar
Efter skapandet visas det hemliga nyckelvärdet i en dialog där du kan kopiera det. Spara det för det anslutna systemet innan du stänger dialogen; värdet kan inte hämtas från den vanliga nyckellistan senare. Nyckeln representerar den valda användaren och är separat från en webhook-hemlighet. Nya API-nycklar kan inte skapas i demosandlådan.
Åtkomst för API-skapade ärenden
API-nyckeln representerar en vald användare och anropen använder den användarens behörigheter. Nyckelns listor över användare och grupper anger standardåtkomst för ärenden som skapas.
Åtkomstlistorna är förval för de nya ärendena och begränsar inte själva uppsättningen API-åtgärder som användaren får utföra. Ändrade förval uppdaterar inte behörigheterna på tidigare skapade ärenden.
Mer om åtkomst för api-skapade ärenden
API-anropen använder den användares behörigheter som nyckeln är kopplad till. Nyckelns åtkomstlistor ger förval för skapade ärenden; de begränsar inte i sig vilka API-åtgärder användaren får utföra. Ändrade förval ändrar inte automatiskt åtkomsten till tidigare skapade ärenden.
Ta bort API-nyckel
Som administratör kan du ta bort en nyckel från dess meny och bekräfta. Vid ett planerat byte uppdaterar du först integrationen med en ny nyckel.
Den borttagna nyckeln kan inte användas för nya anrop. Tidigare skapade dokument och användarens medlemskap finns kvar. Nycklar kan inte tas bort i demosandlådan.
Mer om ta bort api-nyckel
Den borttagna nyckeln kan inte längre användas för nya API-anrop. Dokument som redan skapats finns kvar. Borttagning av nyckeln tar inte bort användarens medlemskap; medlemsborttagning är en separat åtgärd som spärras så länge personen har API-nycklar. Nycklar kan inte tas bort i demosandlådan.
Ändra API-nyckelns inställningar
Som administratör kan du välja redigering i nyckelns meny och spara nya inställningar. Byte av ansluten användare påverkar vilka behörigheter integrationens fortsatta anrop använder. Åtkomstförvalen gäller nya ärenden.
Det hemliga nyckelvärdet byts inte av redigeringen, och befintliga ärenden får inte automatiskt ny åtkomst. Äldre nycklar märkta version 1 saknar redigeringsval. Redigering är avstängd i demosandlådan.
Mer om ändra api-nyckelns inställningar
Den valda användaren och angivna åtkomstmottagare måste finnas i organisationen. Att byta användarkoppling påverkar vilken användares behörigheter integrationens fortsatta anrop använder. Åtkomstförvalen gäller nya ärenden och ändrar inte automatiskt äldre försändelser. Själva hemliga nyckelvärdet byts inte. Redigering är avstängd i demosandlådan.
Visa API-nycklar och deras inställningar
API-nyckellistan ger en överblick över nycklar och sparade inställningar. Använd respektive meny för att redigera eller återkalla en nyckel.
Det hemliga nyckelvärdet visas bara vid skapandet och kan inte hämtas från listan senare. Att öppna listan eller ändra ett namn gör inte värdet synligt igen.
Mer om visa api-nycklar och deras inställningar
Öppna organisationens lista över API-nycklar för att se de registrerade nycklarna och deras inställningar. Det hemliga nyckelvärdet visas inte i listan, och ett ändrat namn gör inte värdet tillgängligt igen. Ta hand om nyckeln när den skapas. Att visa listan ändrar inte nycklarnas behörigheter. Använd respektive åtgärd för att ändra inställningar, skapa en ny nyckel eller återkalla en befintlig.