Introduction

• URLs and Data Format
• Authentication
• Rate Limiting

The Oberplan API is a RESTful web service that allows you to programmatically access and manage your Oberplan data and account information.

URLs and Data Format

API access is via HTTPS only. All calls to the API must start with the base URL https://api.oberplan.com/v1.

API request and response bodies are formatted in JSON.

Authentication

To interact with your Oberplan account, you need to authenticate yourself. Oberplan uses Basic Authentication for all API requests.

Basic Authentication requires an Authorization header with your username (i.e. the email address registered with your Oberplan account) and your account password in the username:password format encoded as Base64.

For example, if your email address is user@example.com and your password is mypassword, a request to the Oberplan API must contain the following header:

Rate Limiting

You can perform up to 100 API requests per 5 minutes period.

You can check your current rate limit and usage details by inspecting the following HTTP headers that are returned on every API response:

The last value will show the time in seconds until the current rate limit window resets.

If the limit is exceeded, then subsequent requests will fail with a 429 (Too Many Requests) HTTP status code.

Note: You can also call the /rate-limit API endpoint to get your current rate limit status.