Getting Started
Three steps to integrate yAppointment into your product.
1. Choose your authentication method
Decide between API keys (server-to-server communication) and OAuth2 (user consent for third-party integrations). Learn how to create and manage credentials for each method.
Read authentication guide →2. Make your first request
Fetch company data with curl, Node.js, or Python in under 5 minutes. See the request envelope format and understand the response structure.
First request tutorial →3. Test in the sandbox
Build against test mode without touching production data. Create test API keys in the admin portal and verify your integration with isolated test companies.
Sandbox guide →
What you'll need
- ✓A yAppointment company account (create one at
https://admin.yappointment.com) - ✓An API key or OAuth credentials (generated in Admin Settings)
- ✓curl, Node.js, Python, or any HTTP client