Planet includes a RESTful API server, which can be enabled in the settings for some use cases.
Enable from Settings
Click the Planet item in the menu bar, and select Settings:
Switch to the API tab and click Start Server. The server will start listening on the selected port; by default, it is 8086.
API Endpoints
The full list of API endpoints is available in the following document:
https://github.com/Planetable/Planet/blob/main/Technotes/API.md
Currently, the API server supports the following basic operations:
- List sites
- Create site
- Delete site
- Publish site
- List articles
- Create article
- Update article
- Delete article
Experimental iOS Client
An experimental iOS client is currently available via TestFlight:
https://testflight.apple.com/join/I4tSZmug
The client needs to talk to an API server to work.
Experimental Web Client
This is an experimental web client created using vanilla JS and HTML/CSS.
https://github.com/livid/planet-web
It has not been optimized for mobile yet.
You need to clone the repo into Planet's public folder to get it to work.
cd ~/Library/Containers/xyz.planetable.Planet/Data/Documents/Planet/Public/
git clone https://github.com/livid/planet-web app
If you are using Croptop, you need to use this location:
cd ~/Library/Containers/xyz.planetable.Lite/Data/Documents/Planet/Public/
git clone https://github.com/livid/planet-web app
It can then be accessed at this address:
Reach the API Server From Anywhere
If you are away from your computer but want to access the Planet API server running on it, the easiest way is to install Tailscale on your devices.
Tailscale creates a magic LAN that connects all your devices.
It is free for personal use.