API's

API's

Welcome to the Solatech API Documentation. Our APIs allow you to integrate your applications with Solatech’s platform, enabling seamless data exchange, process automation, and custom workflows.
This page provides a high-level overview of what an API is, how ours work, and where to get started with our specific services: the Customer API and the Measure Sheet API.

What is an API?

An API (Application Programming Interface) is a set of rules that allows different software systems to communicate. Instead of manually entering data into multiple systems, APIs let you connect them so they can share information automatically.
  • Think of it like a bridge: One application sends a request, and the API returns the response in a structured format.
  • Our APIs use REST principles with JSON payloads over HTTPS.
  • Authentication is required to ensure secure access to your data.

Authentication

All API requests must include an API key in the request header.
  • API keys can be generated from your Solatech-DOS account under the API Keys section.
  • Keep your keys secure — treat them like passwords.
Header Example:
POST https://api.solatech-dos.com/customers/v1/create
Authorization: ApiKey YOUR_API_KEY

If the key is missing, invalid, expired, or does not contain the scope necessary to complete the operation associated with the API endpoint, the API will return a 401 Unauthorized error.

Error Handling

Our APIs return standard HTTP status codes. Make sure your application is prepared to handle these responses gracefully.
  • 200 OK – Request successful
  • 400 Bad Request – Missing or invalid parameters
  • 401 Unauthorized – Authentication failed. This occurs if your API key is missing, invalid, expired, or does not contain the scope necessary to complete the operation associated with the API endpoint
  • 404 Not Found – The requested resource does not exist
  • 500 Internal Server Error – Something went wrong on our end

Best Practices

  • Always authenticate requests.
  • Use pagination when retrieving large lists.
  • Handle errors gracefully in your application.
  • Store API keys securely and never expose them in client-side code.