Skip to main content
Version: 1.0.0

machs-dir-selbst Public API

Integrate external systems with your company's data in the machs-dir-selbst solar planner — customers, projects, offers, materials, services and more — over a predictable REST API, and react to changes in near-real-time via webhooks.

Base URL​

https://api.machsdirselbst.solar

Authentication​

Every request is authenticated with a company-scoped API key sent as a Bearer token (Authorization: Bearer mds_live_...). A key carries a set of scopes that gate what it can read and write. Keys are created under Settings → API Keys in the planner. See the Authentication guide for the scope matrix.

All data is automatically scoped to the key's company — you can only ever read or change your own company's records.

What you can build​

  • CRM / ERP sync — mirror customers, projects and offers into your own systems, and keep them in sync with webhooks.
  • Programmatic offer creation — build a complete offer (roofs, modules, inverters, batteries, wallboxes, services, costs) in one atomic call, then manage individual line items later.
  • Event-driven automation — trigger workflows when an offer is accepted, a project is created, or a customer changes, without polling.
  • Reporting — pull analytics and pipeline data into a BI tool.
  • Document generation — fetch grid-operator (Netzbetreiber) paperwork and string plans for an offer.

Conventions​

  • IDs are returned as strings.
  • Lists accept limit (1–200), offset, sort (field.asc / field.desc, whitelisted per resource) and per-field filters, and respond with { data, total, limit, offset } — offset pagination, so total lets you page deterministically.
  • Writes use the resource's create/update endpoints; several resources (customers, projects, offers) persist through atomic transactions so a partial write can never leave inconsistent data.
  • Errors are { "error": "<code>", "message"?: "<detail>" } with the matching HTTP status: 400 validation, 401 authentication, 403 missing scope, 404 not found in your company, 500 server error.

Authentication​

Pass your API key as a Bearer token: Authorization: Bearer mds_live_.... Keys are managed in the planner under Settings → API Keys.

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

API Key

Contact

machs-dir-selbst:

URL: https://machsdirselbst.solar