How to Use

1. Register with GitHub

To access the Crudify platform and start using the APIs, you need to create an account or log in through your GitHub account. This integration ensures a smooth, secure process for managing your profile and API tokens.

Steps:

• Visit the Crudify website.
• Click on the Login With GitHub button.
• After clicking, you will be redirected to GitHub's Authorize Application page.
• Click Authorize to grant access to Crudify.
• Once authorized, you will be logged in and can access your Profile section by clicking on your Avatar in the top-right corner.
• In the dropdown menu, click on Profile to manage your account settings and API tokens.

By linking your GitHub account, you'll be able to easily manage your API keys and interact with the platform's API endpoints.

2. Generate an API Token

Your API token is the key to authenticating and making requests to the Crudify API. It acts as a security measure, ensuring that only authorized users can access and modify the data.

Upon registering an account, an API token will be automatically generated for you. You can find this token in your Access Token Setting section within your profile.

Steps to Generate an API Token:

1. Once you're logged into Crudify, navigate to your Profile section.
2. Under your Profile menu, locate the Access Token Setting section.
3. Click the Regenerate Token option to create a new token.
4. Copy and securely store the new token, as it will replace the previous one.

Important: Once a new token is generated, the old token becomes invalid. Make sure to update your applications with the new token immediately.

Storing Your API Token

• Keep your API token secure; it grants access to the Crudify platform.
• Do not expose it in public repositories or include it in client-side code.
• Consider using environment variables or a secure vault for storage.

By managing your API tokens properly, you ensure the security and integrity of your data while working with the Crudify API.

3. Select a Project

Now that you understand the API details, it's time to select a project that interests you. For example, you can start with a simple Todo List API or explore more complex projects.

Steps:

• Choose an API project from the available options.
• Review the endpoints and examples to understand how they align with your learning goals.
• Each project comes with clear documentation, so you'll know exactly what data you're working with.

4. Make API Calls

With your API token ready and project selected, it's time to make API calls. The API token serves as a Bearer Token, which must be included in the Authorization header of every request to access Crudify's APIs. This ensures secure and authenticated API interactions.

Using cURL in Terminal

To make an API call using cURL, run the following command in your terminal. Replace "your-api-token-here" with your actual API token and update "{your-endpoint}" with the appropriate API endpoint.

curl -X GET "https://crudify.com/api/{your-endpoint}" \
     -H "Authorization: Bearer your-api-token-here"

Using Bearer Token in a JavaScript Fetch Request

Use the Fetch API in JavaScript to make an authenticated request:

fetch("https://crudify.com/api/{your-endpoint}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer your-api-token-here",
    "Content-Type": "application/json"
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));

Key Takeaways:

• The Authorization header must contain "Bearer your-api-token-here" for secure access.
• Replace "your-api-token-here" with your actual API token.
• Replace "https://crudify.com/api/{your-endpoint}" with the correct API endpoint.
• Keep your API token private and secure to prevent unauthorized access.

5. Build & Learn

The final step is to start building with real API data! With your API calls working, you can now integrate dynamic data into your frontend applications, whether they're built with React, Vue.js, React Native, or Flutter.

• You'll get hands-on experience with how real APIs function.
• Practice creating, reading, updating, and deleting data using CRUD operations.
• Take advantage of the extensive documentation and examples provided with each project to guide your development.

As you interact with the APIs, you'll deepen your understanding of backend integrations and enhance your frontend skills.

Additional Resources

Each Crudify project includes:

• Base URLs for API access, so you know where to direct your API requests.
• Endpoint documentation detailing the parameters and HTTP methods available for each call.
• Request and response examples to help you structure your API calls.
• Status codes and error handling information to understand and manage different responses.