syncloud / platform

Run popular services on your device with one click
https://syncloud.org
GNU General Public License v3.0
392 stars 39 forks source link

[docs] add "API" page to docs #671

Closed klmhsb42 closed 1 year ago

klmhsb42 commented 1 year ago

Would be good to have an doc entry for the syncloud.it API, something like this:

API

syncloud.it API

POST Request

To access the REST API Endpoint of syncloud.it

the url is https://api.syncloud.it/user

the content-type is application/json

the required data is

{
    "email": "user@example.com",
    "password": "secret"
}

Server Response

You will get a list of the activated devices in JSON format.

klmhsb42 commented 1 year ago

I guess there is no API for the platform app (yet), right?

cyberb commented 1 year ago

This is not really a true public api for people to use, this api between device and dns. It evolves over time and documentation will get outdated and will add more confusion. Of cause if we get 100s of developers doing platform development then yes, now there is no need.

Why do you need it?

klmhsb42 commented 1 year ago

This is not really a true public api for people to use, this api between device and dns. It evolves over time and documentation will get outdated and will add more confusion.

Alright, then it's ok, I will close this issue. It was just an idea.

Of cause if we get 100s of developers doing platform development then yes, now there is no need.

Why do you need it?

Actually, just out of curiosity. Sorry I stole your time ;P btw. it's impressive how syncloud developed already over the years and seeing all your effort :)