Skillhabitin asiakasrajapinta

Tervetuloa Skillhabitin asiakasrajapinnan viralliseen dokumentaatioon

Tämä rajapinta tarjoaa vankan joukon päätepisteitä, joiden avulla voi olla vuorovaikutuksessa asiakkaisiin liittyvien tietojen ja Skillhabit-alustan toimintojen kanssa. Olitpa sitten kehittäjä, joka integroi Skillhabit-palveluja sovellukseesi, tai yritys, joka haluaa tehostaa asiakashallintaprosesseja, tämä dokumentaatio opastaa sinua eri päätepisteiden ja käytettävissä olevien resurssien käytössä.

Aloittaminen

Skillhabitin asiakasrajapinnan käytön aloittamiseksi tarvitset API-avaimen, jonka saat ottamalla yhteyttä tukitiimiimme. Kun sinulla on API-avain, voit alkaa perehtyä päätepisteisiin ja tehdä pyyntöjä.

Todentaminen

Useimpiin API-päätepisteisiin pääsy edellyttää todentamista. Käytämme API-avaimia pyyntöjen todentamiseen, mikä takaa turvallisen viestinnän sovelluksesi ja palvelimiemme välillä.

API-päätepisteet

Skillhabitin asiakasrajapinta tarjoaa laajan valikoiman päätepisteitä asiakastilien hallintaan, käyttäjätietojen hakemiseen ja erilaisten hallinnollisten tehtävien suorittamiseen. Nämä päätepisteet on järjestetty loogisiin luokkiin, ja ne tarjoavat RESTful-yhteyden taustalla oleviin resursseihin. Voit tutustua käytettävissä oleviin päätepisteisiin alla olevassa API-viitteessä, jossa kukin päätepiste on dokumentoitu parametreineen, pyyntö- ja vastausmuotoineen ja esimerkkikäyttöineen.

Katso Skillhabitin asiakasrajapintaviite Swagger web editorille >

Katso OpenAPI-lähde >

Webhookit

Webhookit ovat Skillhabit-alustan tehokas ominaisuus, joka mahdollistaa reaaliaikaisen viestinnän sovelluksesi ja Skillhabit-alustan välillä. Rekisteröimällä webhook-päätepisteitä voit saada välittömiä ilmoituksia tietyistä tapahtumista ja päivityksistä, jotka liittyvät asiakastileihin ja -toimintoihin. Näin sovelluksesi voi reagoida dynaamisesti muutoksiin ilman jatkuvia API-kyselyitä.

Datamuodot

API käyttää ensisijaisesti JSONia (JavaScript Object Notation) pyyntöjen ja vastausten hyötykuormiin.

Pyyntömäärärajoitukset

Skillhabitin asiakasrajapinnan reilun käytön varmistamiseksi ja optimaalisen suorituskyvyn ylläpitämiseksi kaikille käyttäjille Skillhabitin asiakasrajapinnan API-pyynnöille on asetettu pyyntömäärärajoitukset. Tämän ei pitäisi vaikuttaa Skillhabitin asiakasrajapinnan normaaliin käyttöön, mutta se on tärkeää pitää mielessä luotaessa suuria pyyntömääriä.

Tuki ja palaute

Olemme sitoutuneet tarjoamaan erinomaista tukea kehittäjille ja otamme mielellämme vastaan palautetta tai kysymyksiä, joita sinulla on rajapinnasta. Jos kohtaat ongelmia, sinulla on parannusehdotuksia tai tarvitset apua integroinnissa, ota yhteyttä tukitiimiimme.

Versionointi

Tämä dokumentaatio koskee Skillhabitin asiakasrajapinnan versiota 1 (v1). Alustan kehittyessä ja uusien ominaisuuksien tullessa käyttöön saatamme julkaista API-päivityksiä, jolloin myös tähän dokumentaatioon tehdään vastaavat tarkistukset. Muista tarkistaa päivitykset säännöllisesti, jotta pysyt ajan tasalla rajapinnan muutoksista ja parannuksista.

Vastuuvapauslauseke

Vaikka pyrimme varmistamaan tässä dokumentaatiossa annettujen tietojen tarkkuuden ja luotettavuuden, huomioithan, että Skillhabitin asiakasrajapinta voi muuttua ilman ennakkoilmoitusta. Suosittelemme tutustumaan tähän dokumentaatioon säännöllisesti uusimpien päivitysten ja ohjeiden saamiseksi.