In the digital age, label managers require efficient tools to oversee their users and associated websites. The Starfish public API emerges as a beacon, offering a comprehensive suite of functionalities tailored for this very purpose. In this article, we'll delve into the core offerings of this API and how label managers can leverage its capabilities.
Starfish public API, version 1.0.0, is meticulously designed to cater to the needs of label managers. It offers a secure and robust interface for managing users and their websites, ensuring label managers have all the tools they need at their fingertips.
User Management: Seamlessly create, retrieve, and manage users.
Website Operations: From initiating a new website to fetching intricate details or even obtaining a zip version, the API has it covered.
Health Checks: Regularly monitor the API's health to ensure uninterrupted operations.
Use Swagger docs page as playground.
Before diving into the API's functionalities, label managers need to authenticate their requests. Here's the step-by-step process:
Authorization: Bearer API_TOKEN
Creating a New User:
Utilize the POST method on /v1/users
, ensuring you provide the necessary name
, email
and password
.
Fetching User Information:
Retrieve specific user details with the GET method on /v1/users/{user_id}
.
Managing User Status:
Suspend or restore user accounts using the PUT method on /v1/users/{user_id}/{action}
.
Initiating a New Website:
Use the POST method on /v1/websites/{user_id}
, providing the website's name
and templateId
.
Retrieving Website Details:
Access information of a particular website using the GET method on /v1/websites/{user_id}/{website_id}
.
Publishing a Website:
Make specific websites live using the PUT method on /v1/websites/{user_id}/{website_id}/publish
.
Obtaining a Website Thumbnail:
Fetch a base64 encoded PNG thumbnail via the GET method on /v1/websites/{user_id}/{website_id}/thumb
.
Downloading a Website as ZIP:
Secure a zipped version of a website through the GET method on /v1/websites/{user_id}/{website_id}/zip
.
The API is adept at providing clear error messages. In case of discrepancies, it returns an Error
with a descriptive message, aiding in swift troubleshooting.