API-viite kehittäjille
Yhdistä oma sovelluksesi työtilaasi: REST API, sen avaimet ja laajuudet, virheet, pyyntörajat ja webhookit.
Mistä sen löytää
⚙️ Asetukset › API-viite · Etusivu › Resurssit › API-viite
Avaa tämä näkymä
Vaiheet
- Avaa “API-viite” sivupalkista tai “API-viite” etusivun “Resurssit”-valikosta.
- Aloita kohdasta “Aloita tästä”: “Perus-URL ja käytännöt”, “Todennus” ja “Laajuudet”.
- Etsi “Päätepisteet” ryhmittäin; jokainen näyttää parametrinsa, pyynnön rungon, vastauksen ja virheet esimerkkeineen.
- Lue “Virheet ja tilakoodit”, “Pyyntörajat” ja “Webhookit (lähtevät)” ennen tuotantoon siirtymistä. “OpenAPI JSON” lataa koko määrittelyn.
Vianmääritys
Miten saan API-avaimen?
Avaimet myönnetään työtilallesi pyynnöstä; niitä ei voi vielä luoda sovelluksessa. Työtilasi avaimet on listattu tekoälyalueen kehittäjäsivulla, jossa työtilaa hallinnoivat voivat myös lisätä ja testata webhook-päätepisteitä.
Vinkit
- Kutsu API:a vain palvelimeltasi. Älä koskaan laita avainta verkkosivulle tai mobiilisovellukseen.
Hyvä tietää
- API-viite on luettavissa ilman kirjautumista.
Aiheeseen liittyvät ohjeet
- Miten löydän päätepisteen ja kopioin esimerkin? Hae API-viitteestä, siirry päätepisteeseen ja kopioi sen esimerkki tai linkki.
- Miten luen usein kysytyt kysymykset (Dokumentaatio)? Lue lyhyitä vastauksia siihen, mitä tuote tekee jo nyt: alkuun pääseminen, kielet ja äänet, testipuhelut, puhelinnumerot, paketit ja tili.
- Ominaisuudet Puhelinkeskuksen ominaisuuksien täydellinen luettelo, jokainen rehellisesti merkittynä toimitetuksi tai suunnitelluksi.