API & Technical Setup

This guide is for developers or technically curious users who want to understand how apocha's calendar integration works behind the scenes.

For non-technical users, all you need to know is in our Quick Start Guide.

The Calendar URL

The foundation of our calendar integration is the Calendar URL. This is a unique URL generated for your account that provides a data feed in the standard iCalendar (.ics) format.

Any calendar application that can subscribe to an internet calendar (which includes virtually all modern calendar apps) can use this URL to display your financial events.

Security: API Keys

To ensure your financial data remains private, the Calendar URL is secured with a unique token: your API key.

• How it works: When you create an API key in the apocha app, it acts as a secret password. This key is embedded in your calendar URL. When your calendar app requests data from the URL, apocha's server validates the API key before sending any information.
• Creating a Key: You can create and manage your API keys by navigating to Settings > Account in the apocha app.
• Revoking Access: If you ever believe your Calendar URL has been compromised, you can simply create a new API key in the apocha app. This will immediately disable the old URL.

API Endpoint

The calendar feature utilizes apocha's public API. While the current primary method of consumption is via calendar app subscription, the underlying data can be accessed programmatically.

• API Documentation: For detailed information on the available endpoints, parameters, and data structures, please refer to our official Swagger UI API Documentation.
• Authentication: All API requests must be authenticated using your API key, typically passed as a bearer token in the request header or a querz parameter.

By using industry-standard formats (.ics) and security practices (API keys), we provide a calendar integration that is both powerful and secure.