Mokapen API -dokumentaatio

Laajuudet ja käyttöoikeudet

Laajuudet määräävät, mitä API-resursseja sovelluksesi voi lukea tai kirjoittaa. Jokaisella laajuudella on organisaation jäsenrooleihin liittyvä käyttöoikeustaso.

Luudat Käyttöoikeustaso Kuvaus Sallitut roolit
tasks.read Julkinen Read tasks owner, user, member, limited_user, guest, admin
tasks.write Siemenet Create or update tasks owner, user, admin
projects.read Julkinen Read projects owner, user, member, limited_user, guest, admin
projects.write Siemenet Create or update projects owner, user, admin
appointments.read Julkinen Read appointments owner, user, member, limited_user, guest, admin
appointments.write Siemenet Create or update appointments owner, user, admin
bookings.read Julkinen Read bookings owner, user, member, limited_user, guest, admin
bookings.write Siemenet Create or update bookings owner, user, admin
contacts.read Julkinen Read contact data owner, user, member, limited_user, guest, admin
contacts.write Siemenet Create or update contacts owner, user, admin
companies.read Julkinen Read company data owner, user, member, limited_user, guest, admin
companies.write Siemenet Create or update companies owner, user, admin
deals.read Julkinen Read deal data owner, user, member, limited_user, guest, admin
deals.write Siemenet Create or update deals owner, user, admin
quotes.read Julkinen Read quote data owner, user, member, limited_user, guest, admin
quotes.write Siemenet Create or update quotes owner, user, admin
orders.read Julkinen Read order data owner, user, member, limited_user, guest, admin
orders.write Siemenet Create or update orders owner, user, admin
services.read Julkinen Read service data owner, user, member, limited_user, guest, admin
services.write Siemenet Create or update services owner, user, admin
products.read Julkinen Read product data owner, user, member, limited_user, guest, admin
products.write Siemenet Create or update products owner, user, admin
tickets.read Julkinen Read ticket data owner, user, member, limited_user, guest, admin
tickets.write Siemenet Create or update tickets owner, user, admin
documents.read Julkinen Read document data owner, user, member, limited_user, guest, admin
documents.write Siemenet Create or update documents owner, user, admin
campaigns.read Julkinen Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write Siemenet Create or update campaigns owner, user, admin
profile.write Siemenet Update profile roles and preferences owner, user, admin
users.write Siemenet Manage teams and team members owner, user, admin

Kuinka kaukoputket toimivat

Valitse sovellusta luotaessa laajuudet, joita se voi pyytää. Ajon aikana tunnuksen on sisällettävä päätepisteen vaatima laajuus (esim. tasks.read tehtävien luetteloimiseksi).

Julkisissa (kolmannen osapuolen) sovelluksissa Mokapen tarkistaa myös, että todennetun käyttäjän rooli organisaatiossa on sallittu kullakin laajuustasolla.

  • Public — saatavilla omistajalle, järjestelmänvalvojalle, käyttäjälle, jäsenelle, rajoitettu käyttäjälle ja vieraalle.
  • Puolirajoitettu — saatavilla omistajalle ja käyttäjälle.
  • Restricted — saatavilla vain omistajille (sisältää profile.write ja users.write profiilin ja tiimin hallintaan).

Pyydä laajuuksia

Sovellus julkinen: välitä laajuudet välilyönnillä eroteltuna luettelona OAuth-valtuutus-URL-osoite- ja tunnuspyynnössä.

Yksityiset sovellukset: laajuudet otetaan sovelluksen määrityksistä tunnuksen luomisen aikana.

scope=tasks.read tasks.write contacts.read companies.read

Aloita työskentely säästäen aikaa.

tai
Varaa demo

Tarvitsetko apua?