739ef153f6
* docs: improve English naturalness in API v2 documentation - Fix awkward API summary 'Find out when is an event type ready to be booked' to 'Get available time slots for an event type' - Correct 'setup' vs 'set up' usage throughout documentation - Fix OAuth capitalization consistency - Improve 'api' to 'API' capitalization in v2 docs - Enhance readability while preserving technical accuracy Fixes unnatural English phrasing in titles, headers, descriptions, and summaries across API v2 documentation files. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * docs: add missing articles 'the' in API v2 documentation - Fix 'How to Set Up API' to 'How to Set Up the API' in titles - Add 'the' before 'API' in descriptions and summaries - Fix grammar error 'all you need to is' to 'all you need to do is' - Improve naturalness while maintaining technical accuracy Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * docs: fix unnatural English in API v2 @ApiOperation summaries - Fix grammatically incorrect 'conferencing apps oauths callback' to 'Conferencing app OAuth callback' - Replace 'ooo' with 'out-of-office' in user-facing summaries for clarity - Ensure consistent sentence case capitalization (only first letter capitalized) - Remove trailing periods from summaries for consistency - Fix awkward phrasing like 'Get by attribute id all of...' to more natural English - Revert 'Introduction to the API v2' back to 'Introduction to API v2' - Improve naturalness while maintaining technical accuracy Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * Update apps/api/v2/src/modules/slots/slots-2024-09-04/controllers/slots.controller.ts * Update docs/api-reference/v2/openapi.json * docs: fix setup/set up usage - use 'backend setup' (noun) not 'backend set up' (verb) Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * docs: fix setup/set up verb usage - use 'set up' (verb) not 'setup' (verb) - Fix 'You have to setup' → 'You have to set up' in quickstart.mdx - Fix 'Setup environment variables' → 'Set up environment variables' - Fix 'Setup root of your app' → 'Set up root of your app' - Fix 'prompted to setup' → 'prompted to set up' in setup.mdx Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * Ran v2 locally to regen the doc json files --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
55 lines
3.3 KiB
Plaintext
55 lines
3.3 KiB
Plaintext
---
|
|
title: FAQ
|
|
description: Answers to the most common questions about the Platform API and atoms.
|
|
"icon": "comments"
|
|
---
|
|
### 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 the API calls is being handled by the atom, all you need to do is import the atom and drop it in your code.
|
|
|
|
### 6. What are the minimum setup requirements 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.
|
|
|
|
### 8. Why toggle animation is not working in the AvailabilitySettings atom?
|
|
- For the AvailabilitySettings toggle animation to work set the reading direction on the `<html>` element:
|
|
```html
|
|
<html dir="ltr"> ... </html>
|
|
```
|
|
|
|
### 9. What are the authentication methods for making calls to the v2 API?
|
|
Either of the two:
|
|
- Setting `Authorization: Bearer <token>` header where `<token>` is access token of the managed user.
|
|
- Setting `x-cal-client-id: <client-id>` and `x-cal-secret-key: <client-secret>` where `<client-id>` is OAuth client id and `<client-secret>` is OAuth client secret. Both can be copied from the dashboard.
|
|
|
|
### 10. When am I charged and not charged ?
|
|
- You are charged for scheduled booking only when the booking starts.
|
|
- If a booking is rescheduled you are still charged once.
|
|
- If a booking is cancelled then you are not charged for it.
|
|
|
|
### 11. What happens if there are more bookings than in my plan?
|
|
- You have to pay overage for each booking that exceeds the amount in your plan.
|