be728e9c01
* feat: Add Mintlify docs * Fixed the mint.json for v2 * Fixed versioning issue * Add titles to ICS feed endpoints * Added errors to v1 * Added rate-limit to API v1 * feat: added v1-v2 differences and v1 auth * Trying to eliminate reasons for v1 not showing on publication * Used the swagger openapi validator * remove deprecated v1 endpoints * Moved api docs into new folders without api-reference * Renamed api to api-reference * removed the versioning * Got rid of anchor warnings * Fixed naming * Just as a test - using the same v2 openapi spec for v1 reference * Removed 'externalDocs' from v1 * Removed securitySchemes * Updated the diff between v1/v2 * Added v1 in front of /attendees to test * Moved paths up and removed externalDocs * Testing - Added content to the response * Reduced paths to 1 * Testing: anything at this point * Fixed validation * Moved the other .mdx files to see if that's disrupting something * Trying with a tab * Empty tags array * Added back servers field * Removed all other schemas * Removed v1 for now * Added platform docs * Language fixes * Added v1 back * add API V1 response for attendees * remove unnecessary endpoint docs in API V1 * Removing platform and API for now * Updated v2 openapi doc --------- Co-authored-by: Syed Ali Shahbaz <alishahbaz7@gmail.com>
35 lines
2.3 KiB
Plaintext
35 lines
2.3 KiB
Plaintext
---
|
|
title: FAQ
|
|
description: Answers to the most common questions about the Platform API and atoms.
|
|
---
|
|
### 1. What is an OAuth client?
|
|
- A platform OAuth client enables you communicate with our API and manage your users.
|
|
- It contains properties such as name, redirect uris and permissions required by your users.
|
|
|
|
### 2. What is a managed user?
|
|
- A managed user is just a representation of your user within our database containing basic information like e-mail.
|
|
- It can be used to manage the setup of integrations such as Google Calendar, your users bookings. availability, etc.
|
|
- You should store information about the managed users in your database and use the access token to make API calls on their behalf.
|
|
|
|
### 3. Are a cal.com user and a managed user related?
|
|
- No, a cal.com user and a managed user are not related in any way. We can consider them as two separate entities.
|
|
- A "managed user" is completely independent of user accounts on cal.com and you don't need to register users on the cal.com web application.
|
|
|
|
### 4. What is an access token?
|
|
- At the time of creating a managed user you'll be provided with an access token and a refresh token.
|
|
- Each managed user is linked with an access token which helps us in identifying which users scheduling we need to handle.
|
|
- The access token only lasts for 60 minutes after which you can query the refresh point with your refresh token which will give you a new access token.
|
|
- Inside of atoms we handle access token refreshing part ourselves, outside of that you may need to handle the refreshing part yourselves.
|
|
- Refresh tokens should never be exposed to the frontend, keep them secure and only use them on the backend.
|
|
|
|
### 5. What is an atom?
|
|
- An atom is a customizable UI component that handles scheduling on behalf of your user.
|
|
- Everything from the front-end to API calls is being handled by the atom, all you need to is import the atom and drop it in your code.
|
|
|
|
### 6. What are the minimun setup requirments for using atoms?
|
|
- You need to have a project that uses React version 18 and above.
|
|
- At the moment atoms are only supported in React, so there's no way to use them in vanilla js or any other popular framework.
|
|
|
|
### 7. Can recurring events be rescheduled?
|
|
- No, at the moment you are only allowed to cancel a recurring event.
|