API-referens för utvecklare
Anslut din egen app till din arbetsyta: REST-API:et, dess nycklar och behörigheter, fel, hastighetsgränser och webhookar.
Var du hittar det
⚙️ Inställningar › API-referens · Startsida › Resurser › API-referens
Öppna den här skärmen
Steg
- Öppna “API-referens” i sidofältet, eller “API-referens” i startsidans meny “Resurser”.
- Börja med “Börja här”: “Bas-URL och konventioner”, “Autentisering” och “Behörigheter”.
- Slå upp “Slutpunkter” per grupp; var och en visar parametrar, anropskropp, svar och fel med exempel.
- Läs “Fel och statuskoder”, “Hastighetsgränser” och “Webhookar (utgående)” innan du går live. “OpenAPI JSON” laddar ned hela specifikationen.
Felsökning
Hur får jag en API-nyckel?
Nycklar utfärdas för din arbetsyta på begäran; de kan ännu inte skapas i appen. Arbetsytans nycklar listas på utvecklarsidan i AI-området, där de som hanterar arbetsytan också kan lägga till och testa webhook-slutpunkter.
Tips och råd
- Anropa API:et endast från din server. Lägg aldrig en nyckel i en webbsida eller en mobilapp.
Bra att veta
- API-referensen kan läsas utan inloggning.
Relaterade instruktioner
- Hur hittar jag en slutpunkt och kopierar ett exempel? Sök i API-referensen, hoppa till en slutpunkt och kopiera dess exempel eller länk.
- Hur läser jag de vanliga frågorna (Dokumentation)? Läs korta svar om vad produkten gör i dag: att komma igång, språk och röster, testsamtal, telefonnummer, planer och konto.
- Funktioner Hela katalogen över callcenterfunktioner, var och en ärligt märkt som levererad eller planerad.