Solarware API

Solarware public REST API v1 (mail-service `/api/v1` → Solarware `/api/v3/external`). Authenticate every request with header `X-Api-Key: {your_api_key}` (also accepted: `X-API-KEY`, or query `?api_key=`). Contacts & Partners use nested CRM arrays (`addresses`, `emails`, `phones`). Legacy flat partner fields (`street`, `email`, `telefone`, …) are not accepted. List endpoints support `search` across entity + nested CRM fields with `page` / `per_page`. Create endpoints accept optional `Idempotency-Key` for safe retries (Make/Zapier/n8n).

Base URL

/api/v1 Public API v1 base path

Version 1.8.0

Authentication

ApiKeyAuth apiKey

Your Solarware API key.

Default security applies to operations unless overridden.

Endpoint groups

Country lookup helpers (use `id` as `countries_id` on addresses).

Unit lookup helpers (use `id` as `unit_id` on products).

Product category lookup (use `id` as `categories_id` on products).

Salutation lookup (use `id` as `salutations_id` on contacts).

Title lookup (use `id` as `titles_id` on contacts).

Deal tag lookup (use `id` as `tags_id` on deals).

Contact records with nested CRM details and top-level /addresses /emails /phones for per-row CRUD.

Partner records with nested CRM details and top-level /addresses /emails /phones for per-row CRUD.

Top-level CRM addresses. Create/list with exactly one of contacts_id or partners_id.

Top-level CRM emails. Create/list with exactly one of contacts_id or partners_id.

Top-level CRM phones. Create/list with exactly one of contacts_id or partners_id.

Catalog products (name, prices, stock, optional categories_id / unit_id). Cover image via POST /products/{id}/image; gallery via POST /products/{id}/files.

Sales contracts.

Sales invoices.

Deal pipelines with nested phases (use phase id as phase_id on deal create).

Deals. Create can link existing contact/partner ids or create nested contact/partner objects. Update/delete/move phase via /deals/{id} and POST /deals/{id}/move. Read and update field values via GET and POST /deals/fields.

Deal tasks. Optional deals_id; type other/call/email; status to-do/done.

Deal notes. Create requires deals_id.

Solar installation sites (name, address, status).