Document description
<p><strong>Open Platform Overview</strong></p>
<ul>
<li>
<p>Growatt's OpenAPI open platform provides standardized RESTful data call services for authenticated users</p>
</li>
<li>The platform interface is based on the http(s) protocol and uses the OAuth2.0 authentication mechanism.</li>
</ul>
<p><strong>API Usage Process</strong></p>
<ul>
<li>Create an account
<ol>
<li>OSS account creation
Enter <a href="http://oss-cn.growatt.com/login">http://oss-cn.growatt.com/login</a> in the browser address bar, and you will see the following interface:
Select "Register" in the upper right corner of the page
If you did not purchase the equipment directly under a contract with Growatt, please select an installer, and fill in the company name and address truthfully.
If you purchased the equipment directly under a contract with Growatt, please select a distributor, and the "Company Name" here must be 100% the same as the company name on the signed contract, and the "Order Number" can be obtained from Growatt sales staff.
<img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=d47f73cf2b85d21cdea9ed840df751d5&amp;file=file.png" alt="" /></li>
</ol></li>
</ul>
<ol>
<li>OSS account creation address:
<a href="https://oss.growatt.com/index">https://oss.growatt.com/index</a> (European and other global users),
<a href="https://oss-cn.growatt.com/index">https://oss-cn.growatt.com/index</a> (Chinese users),
<a href="https://oss-us.growatt.com/index">https://oss-us.growatt.com/index</a> (North American users)
<a href="https://oss-au.growatt.com/login">https://oss-au.growatt.com/login</a> (Australian and New Zealand users)</li>
</ol>
<ul>
<li>
<p>Token application
Log in to the OSS account, click System Settings-System Management-Add API in the left menu bar Apply.<img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=1d4413d9b84d94b78ced24e24360012e&amp;file=file.png" alt="" />
Growatt is responsible for protecting the privacy and security of user power station data, and needs to confirm that third-party data calls are safe and reliable. When applying for API-token, please confirm that all the information you fill in must be true (whitelist is recommended to be filled in, otherwise once the server determines that the non-fixed IP call data is a malicious call, the token used will be shut down). Once your application information is reviewed and approved, a randomly generated token will be sent directly to the email address you filled in.</p>
</li>
<li>Specify an account
<ol>
<li>If you have registered a user on the server monitoring platform and have successfully monitored the device, specify the token as the server user and directly obtain data, as shown in the following figure:
<img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/3444caee1bf67ab39ff3c67860b40a06" alt="" /></li>
</ol></li>
</ul>
<ol>
<li>If you have not registered a user on the server monitoring platform, register a server user at the server address corresponding to the token; then use the API and obtain data according to the following steps:
a. Register a user
b. Create a power station based on the registered user
c. Add a collector based on the user and power station
d. Obtain device information based on user, power station and collector information
f. Obtain detailed device data based on device information
You can also specify a token in the account management under the terminal user settings, as shown in the figure below:</li>
</ol>
<p><img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/55e7a916fd49c4b9e3c638710338cd19" alt="" /></p>
<ul>
<li>
<ol>
<li>End users need to contact the corresponding installer to apply for a token
Installer or distributor OSS account</li>
</ol>
</li>
</ul>
<p><img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=67ff9bdf1d7801d0682b0f4a1ec74b62&amp;file=file.png" alt="" /></p>
<p><strong>Token Description</strong></p>
<ul>
<li>
<p>TOKEN validity period
Approved: Permanent (tentative)</p>
</li>
<li>
<p>Reason for authorization failure
User cancellation of authorization
User manual cancellation of authorization is not yet available</p>
</li>
<li>
<p>TOKEN length
Token: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Token is generally defined as a 32-bit verification code</p>
</li>
<li>Test token
6eb6f069523055a339d71e5b1f6c88cc</li>
</ul>