Overview
Schedly's API & Developer Tools empower developers to seamlessly integrate scheduling features into their own applications, automate tasks, and customize user experiences. This capability is vital for businesses wanting fluid interoperability and expanded functionality beyond their core Schedly dashboard.
Prerequisites
- Access to your Schedly account as an Admin or Member with API permissions.
- Valid API key available from Schedly's developer's section.
- Knowledge of API consumption in your development environment.
Step-by-Step Instructions
Navigating Schedly's API Documentation
- Log In to Schedly: Navigate to the Schedly login page, enter your credentials, and click the Sign in button.
- Access Developer Tools: Once logged in, click Developers on the main navigation menu.
- Open API Documentation: Locate and click on API Documentation. This area contains all endpoints, authentication methods, and example requests.
Authenticating and Making API Requests
- Generate an API Key: In the Developer Tools section, click API Keys. Hit New Key, name your key, and click Generate. Copy this key—it's viewable only once.
- Setup Authentication: In your application, set the request headers to include
Authorization: Bearer <YOUR_API_KEY>in each API call. - Test API Calls: Use the Try It feature in the documentation to send sample requests and understand response formats.
Connecting Schedly to Third-Party Systems
- Review Integration Requirements: Assess the needs of your third-party system for scheduling functionalities.
- Set up Webhooks: In the Integrations section, click Set up Webhooks. Enter the third-party system's webhook URL.
- Configure Event Triggers: Select event types (e.g., booking created, booking canceled) that should trigger webhooks, and click Enable.
- Verify Connection: Execute a test transaction in Schedly and ensure that it is recognized by your third-party system.
Diagnosing and Resolving Integration Errors
- Check Logs: Go to API Logs in the Developer Tools to review request and response logs for errors.
- Correct Authentication Issues: Ensure that your API key is not expired or revoked, and check request headers for authentication correctness.
- Validate Endpoints: Ensure endpoints you're interacting with reflect the latest from the documentation and adjust your requests accordingly.
- Contact System Administrator: If you manage SAML/OIDC integrations, ensure these are correctly configured as unauthorized errors might relate to misconfigurations.
Key Details & Limits
- API key is viewable only once; securely store it when generated.
- Schedly offers OAuth2.0 Bearer token authentication.
- Supported protocols for SSO include SAML/OIDC.
- API rate limits: 1000 requests per hour.
Frequently Asked Questions
- What happens if my API key is lost?
- Generate a new API key from the Developer Tools section and update your applications with the new key.
- Can I set up multiple webhooks?
- Yes, there is no limit on the number of webhooks you can establish for different event actions.
- How do I troubleshoot 'Unauthorized' API responses?
- Verify that your API key is included correctly in the request headers and is active.
- What is the rate limit for API calls?
- The rate limit is 1000 requests per hour, which applies globally per user/account.
- Is it possible to use both SAML and OIDC for integrations?
- Yes, Schedly supports both SAML and OIDC for robust integration options.
Troubleshooting
- API calls are failing consistently: Verify network connectivity and API endpoint URLs.
- Webhook triggers do not work: Ensure the third-party endpoint is accessible and correctly configured to receive Schedly's POST requests.
Related Topics
- Introduction to Schedly APIs: Learn about what you can do with Schedly APIs.
- Setting Up Single Sign-On (SSO): How to set up SAML/OIDC for seamless authentication.
- Managing Magic Link Logins: Guide on configuring passwordless login using magic links.