title: “Creating APIs” description: “Step-by-step guide to creating APIs on the platform.”
Creating APIs
This guide will walk you through the process of creating an API on the platform, even if you have no prior technical knowledge. Simply follow the steps carefully to configure your API as per your requirements.
Open the APIs Tab
1. Log in to Your Account – Start by logging into your account on the platform. 2. Navigate to the APIs Tab – Once logged in, locate and click on the “APIs” tab from the main dashboard or navigation menu.
Click the “Create API” Button
- Once inside the APIs section, find and click the “Create API” button. This will open a form where you can enter the necessary details for your new API.
Enter API Details
You will now be required to provide essential details for your API:
1. API Name – Enter a clear and descriptive name for your API. This helps in identifying it later. 2. API Description – Provide a brief explanation of what your API will do. 3. API Type or Method – Choose the appropriate type or method for your API. The available options usually include: - GET – Used to fetch data from the server. - POST – Used to send new data to the server. - PUT – Used to update existing data. - DELETE – Used to remove data. - UPLOAD – Used for uploading files or media. - DOWNLOAD – Used for retrieving files or media. - CUSTOM – A custom method defined for specific use cases More Details.
Click “Create”
- Once you have filled in the required details, click the “Create” button to generate your API.
Configure Your API
After creating the API, you will be directed to the API configuration page, where you can customize it based on your requirements:
1. Set Access Permissions
- Public API – Anyone can access the API. - Private API – Restricted access; only authorized users can use it.
2. Group APIs Together
- Under the “Configurations” section, you will find an option to change the API Group. - Grouping APIs together helps in better management and organization.
3. Select a Data Store and Data Model
- Choose the database (MongoDB, MongoDB Atlas, PostgreSQL, etc.) that will store the API data. - Select the appropriate data model that the API will interact with.
4. Add Pre-Scripts and Post-Scripts (Optional)
- Pre-Scripts – These scripts run before the API executes and can be used for validation or data transformation. - Post-Scripts – These scripts run after the API executes and can be used for logging or additional processing.
Refer to Documentation
If you need guidance at any point, refer to the platform’s documentation for detailed explanations, best practices, and examples.
Click “Save” to Finalize API Creation
- Once all configurations are complete, click the “Save” button to finalize the API setup. - Your API is now ready for use!
By following these steps, you have successfully created and configured an API. You can now integrate it into your applications and start using it.