API V2.0: Difference between revisions
Jump to navigation
Jump to search
| Line 293: | Line 293: | ||
The API V2 changelog is [[API_V2.0_changelog|available here]]. | The API V2 changelog is [[API_V2.0_changelog|available here]]. | ||
= FAQ= | =FAQ= | ||
==How do I access API V2?== | |||
Create an invite code under Settings -> Apps & Integrations -> API. | |||
Exchange this invite code for a refresh token and token using the POST /authentication/setup endpoint. | |||
Include the token in your requests to authenticate them. | |||
==How long do invite codes/tokens last?== | ==How long do invite codes/tokens last?== | ||
Invite codes expire after 15 minutes. | Invite codes expire after 15 minutes. | ||
Refresh tokens last forever so long as they are being used. | Refresh tokens last forever so long as they are being used. Unused refresh tokens expire after 30 days. | ||
Tokens expire after 24 hours. | |||
Tokens | ==What are scopes?== | ||
Scopes limit what your token can do. | |||
For example, the read/bookings scope allows your token to retrieve bookings via the API, but if your token does not have the write/bookings scope then it cannot be used to create or modify bookings. | |||
==Where are scopes set?== | |||
Scopes are set when you create an invite code. | |||
Scopes cannot be changed later, you must create a new invite code with the scopes you want and exchange it for a new token. | |||
==How big are tokens?== | |||
Tokens will be between 152 and 172 characters long | |||
==What is the API credit limit?== | ==What is the API credit limit?== | ||
| Line 321: | Line 339: | ||
==Can I use API V2 to send pictures or webhooks?== | ==Can I use API V2 to send pictures or webhooks?== | ||
Currently no, however these features are coming soon. | Currently no, however these features are coming soon. | ||