Skip to content

Update API URLs to version 3 in documentation #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sandboxcode wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update API URLs to version 3 in documentation #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9baddf4
Update API URLs to version 3 in documentation
sandboxcode Mar 29, 2026
9093b20
Fixed typo in API URL in authentication section of documentation
sandboxcode Mar 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions cloudapi-de.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Rate limiting ist nicht vorgesehen. Es macht jedoch keinen Sinn mehr als eine Ab

Die URLs zum Abfragen bzw Setzen der Parameter am go-eController lauten:
<pre>
https://<b>serial_number</b>.api.controller.go-e.io/api/status
https://<b>serial_number</b>.api.controller.go-e.io/api/set
https://<b>serial_number</b>.api.v3.go-e.io/api/status
https://<b>serial_number</b>.api.v3.go-e.io/api/set

</pre>

Wobei **serial_number** durch die jeweilige 6-stellige Seriennummer des Controllers ersetzt werden muss - mit führenden 0
Expand All @@ -34,7 +35,7 @@ Authorization: Bearer <b>myapitoken</b>

Falls die Authentifizierung mittels GET Parameter erfolgen soll, ist der Authentifizierungstoken als **token** Parameter anzugeben:
<pre>
https://<b>serial_number</b>.api.controller.go-e.io/api/status?token=<b>myapitoken</b>
https://<b>serial_number</b>.api.v3.go-e.io/api/status?token=<b>myapitoken</b>
</pre>


Expand All @@ -57,15 +58,15 @@ Durch setzen des GET Parameters kann ein beliebiger Zeitraum eingestellt werden.

Beispiel:
<pre>
https://000001.api.controller.go-e.io/api/status?token=myapitoken<b>&age=5</b>
https://000001.api.v3.go-e.io/api/status?token=myapitoken<b>&age=5</b>
</pre>

### filter Parameter
Mit dem GET Parameter `filter` kann ausgewählt werden, welche api keys des Controllers mitgesendet werden. Die api keys müssen durch Beistriche getrennt werden.

Beispiel:
<pre>
https://000001.api.controller.go-e.io/api/status?token=myapitoken&age=5<b>&filter=ccn,ccp,cec</b>
https://000001.api.v3.go-e.io/api/status?token=myapitoken&age=5<b>&filter=ccn,ccp,cec</b>
</pre>

## /api/set
Expand All @@ -83,5 +84,5 @@ Um numerische Werte von Strings zu unterscheiden zu können, sollten Strings mit

Beispiel:
<pre>
https://000001.api.controller.go-e.io/api/set?<i>token=myapitoken</i>&<b>fna="my go-eController"</b>
https://000001.api.v3.go-e.io/api/set?<i>token=myapitoken</i>&<b>fna="my go-eController"</b>
</pre>
12 changes: 6 additions & 6 deletions cloudapi-en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Rate limiting is not used. However, it makes no sense to do more than one query

The URLs for querying or setting the parameters on the go-eController are:
<pre>
https://<b>serial_number</b>.api.controller.go-e.io/api/status
https://<b>serial_number</b>.api.controller.go-e.io/api/set
https://<b>serial_number</b>.api.v3.go-e.io/api/status
https://<b>serial_number</b>.api.v3.go-e.io/api/set
</pre>

Whereby **serial_number** must be replaced by the respective 6-digit serial number of the Controller - with leading 0s
Expand All @@ -34,7 +34,7 @@ Authorization: Bearer <b>api-key</b>

If the authentication is done by using the GET parameter, the authentication token must be specified as a **token** parameter:
<pre>
https://<b>serial_number</b>.api.controller.go-e.io/api/status?token=<b>api-token</b>
https://<b>serial_number</b>.api.v3.go-e.io/api/status?token=<b>api-token</b>
</pre>


Expand All @@ -57,15 +57,15 @@ Any time period can be set by setting the GET parameter. However, there is no gu

Example:
<pre>
https://000001.api.controller.go-e.io/api/status?token=myapitoken<b>&age=5</b>
https://000001.api.v3.go-e.io/api/status?token=myapitoken<b>&age=5</b>
</pre>

### filter parameter
The GET parameter `filter` can be used to select which api keys of the Controller are to be sent. The api keys must be separated by commas.

Example:
<pre>
https://000001.api.controller.go-e.io/api/status?token=myapitoken&age=5<b>&filter=ccn,ccp,cec</b>
https://000001.api.v3.go-e.io/api/status?token=myapitoken&age=5<b>&filter=ccn,ccp,cec</b>
</pre>

## /api/set
Expand All @@ -83,5 +83,5 @@ In order to be able to distinguish numerical values from strings, strings should

Example:
<pre>
https://000001.api.controller.go-e.io/api/set?<i>token=myapitoken</i>&<b>fna="my go-eController"</b>
https://000001.api.v3.go-e.io/api/set?<i>token=myapitoken</i>&<b>fna="my go-eController"</b>
</pre>