idyle's Application Programming Interface (API) powering its services and applications.
idyle's API is accessible via https://api.idyle.app.
The API is used by idyle's app. All registered users can also interact with the API directly by retreiving their Access Token by visting the Accounts section of the idyle.app website.
This API has a standard IP-based rate limit. There is also a user-based rate limit based on the user's plan. Check your plan on the Payments section to find out.
const request = async () => {
const options = {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer YOUR_TOKEN_HERE`
},
};
const url = 'https://api.idyle.app/users/get/user/user';
const request = await fetch(url, options);
const response = await request.json();
return response;
};The API is divided into six middlewares that correspond to each of idyle's services. These are namely:
- Auth
- Payments
- Editor
- Deployer
- Objects
- Documents
As such, they may be accessed through the following pattern below.
https://api.idyle.app/{service}/...
https://api.idyle.app/auth
Verifies whether a credential is valid or not.
RETURNS True or false boolean.
Generates a long-lived session token.
RETURNS Long-lived session token string.
Revokes a short-lived access or long-lived session token.
RETURNS True or false boolean.
Gets user data based on the user id. Entering in user retrieves the data of the calling user.
REQUIRES A valid User ID.
RETURNS User data object.
Sets user data based on the user identifier. Entering in user retrieves the data of the calling user.
ACCEPTS Query "type" with value "email".
REQUIRES A valid User ID or User email.
RETURNS User data object.
https://api.idyle.app/payments
Generates a checkout link for a specified plan based on an ID.
REQUIRES A valid plan ID
RETURNS A checkout link.
Confirms a completed purchase for a plan based on an ID
REQUIRES A valid session ID
RETURNS True or false boolean.
Cancels an active subscription based on an iD.
REQUIRES A valid subscription ID
RETURNS True or false boolean.
Gets metrics data for a user based on usage.
RETURNS User metrics data object.
https://api.idyle.app/editor
Lists all pages. Entering in user as the path uses editor's default path.
REQUIRES A valid path.
RETURNS Array of page data objects.
Creates a page. Entering in user as the path uses editor's default path.
REQUIRES A valid path.
RETURNS Page ID string.
Updates page data. Entering in user as the path uses editor's default path.
REQUIRES A valid path and valid page ID.
RETURNS Page ID string.
Gets a page. Entering in user as the path uses editor's default path.
REQUIRES A valid path and valid page ID.
RETURNS Page data object.
Gets a page. Entering in user as the path uses editor's default path.
REQUIRES A valid path and valid page ID.
RETURNS True or false boolean.
Converts editor or document data into an HTML file. Entering in user as the path uses editor's default path.
REQUIRES A valid path and valid page ID.
ACCEPTS Query "type" with value "custom". In this case, the id parameter should be a valid document ID. Query "output" with value "string".
RETURNS Path of the HTML file. If output=string query is specified, HTML string is returned instead.
Converts all editor data into an HTML file in bulk. Entering in user as the path uses editor's default path.
REQUIRES A valid path and valid page ID.
ACCEPTS Query "output" with value "string".
RETURNS True or false boolean. If output=string query is specified, an array of HTML strings is returned.
https://api.idyle.app/deployer
Lists all websites
RETURNS An array of website objects.
Sets up a user's website.
REQUIRES A valid website name.
RETURNS True or false boolean.
Lists all created deploys.
RETURNS An array of deploy objects.
Makes a deploy to an existing website.
REQUIRES An existing website name.
RETURNS Deploy ID and timestamp of completion
Connects a custom domain to an existing website.
REQUIRES A valid domain name.
RETURNS True or false boolean.
Disconnects an existing custom domain attached to a website.
RETURNS True or false boolean.
https://api.idyle.app/objects
Uploads a file. Entering in user as the folder uses objects's default folder.
REQUIRES Valid folder name and valid file name.
RETURNS File object.
Deletes a file. Entering in user as the folder uses objects's default folder.
REQUIRES Valid folder name and valid file name.
RETURNS True or false boolean.
Gets file metadata. Entering in user as the folder uses objects's default folder. Specifying query type returns the file data.
ACCEPTS Query "type" with value "download".
REQUIRES Valid folder name and valid file name.
RETURNS File metadata in form of an object or file data in the form of a buffer, if query.
Makes a file publicly accessible. Entering in user as the folder uses objects's default folder.
REQUIRES Valid folder name and valid file name.
RETURNS True or false boolean.
Lists all file names. Entering in user as the folder uses objects's default folder.
REQUIRES Valid folder name.
RETURNS Array of file names.
Archives a folder and uploads a compressed zipped file. Entering in user as the folder uses objects's default folder.
REQUIRES Valid folder name.
RETURNS True or false boolean.
https://api.idyle.app/documents
Inserts a JSON document. Entering in user as the collection uses documents's default collection.
REQUIRES Valid collection name and valid object ID.
RETURNS True or false boolean.
Updates a JSON document. Entering in user as the collection uses documents's default collection.
REQUIRES Valid collection name and valid object ID.
RETURNS True or false boolean.
Updates a JSON document. Entering in user as the collection uses documents's default collection.
REQUIRES Valid collection name and valid object ID.
RETURNS True or false boolean.
Updates a JSON document. Entering in user as the collection uses documents's default collection.
REQUIRES Valid collection name and valid object ID.
RETURNS True or false boolean.
Updates a JSON document. Entering in user as the collection uses documents's default collection.
REQUIRES Valid collection name and valid object ID.
RETURNS JSON document object.
Lists all documents. Entering in user as the collection uses documents's default collection.
REQUIRES Valid collection name and valid object ID.
RETURNS Array of document objects.