Using the API

Learn how to effectively use the Wayvo API to interact with your applications.

Using the API

The Wayvo API allows you to programmatically interact with your applications, enabling you to automate tasks, integrate with other systems, and extend functionality. This section covers how to make effective use of the API.

Making API Requests

1. Setup

   • Ensure you have your API key or OAuth 2.0 access token ready.
   • Use tools like cURL, Postman, or any HTTP client to make API requests.

2. Endpoint Structure

   • The base URL for the Wayvo API is https://api.wayvo.ai/v1.
   • Each endpoint corresponds to a specific resource, such as users, projects, or tasks.

3. Headers

   • Include necessary headers in your requests, such as Authorization and Content-Type.

   {
     "Authorization": "Bearer YOUR_ACCESS_TOKEN",
     "Content-Type": "application/json"
   }
   

Performing CRUD Operations

1. Create (POST)

   • Use the POST method to create new resources.
   • Example: Creating a new project.

   curl -X POST "https://api.wayvo.ai/v1/projects" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -d '{
     "name": "New Project",
     "description": "Project description"
   }'
   

2. Read (GET)

   • Use the GET method to retrieve resources.
   • Example: Fetching a list of users.

   curl -X GET "https://api.wayvo.ai/v1/users" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
   

3. Update (PUT/PATCH)

   • Use the PUT or PATCH method to update existing resources.
   • Example: Updating user information.

   curl -X PUT "https://api.wayvo.ai/v1/users/{id}" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -d '{
     "name": "Updated Name",
     "email": "updated.email@example.com"
   }'
   

4. Delete (DELETE)

   • Use the DELETE method to remove resources.
   • Example: Deleting a task.

   curl -X DELETE "https://api.wayvo.ai/v1/tasks/{id}" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
   

Filtering and Pagination

1. Filtering

   • Use query parameters to filter results.
   • Example: Fetching users with a specific role.

   curl -X GET "https://api.wayvo.ai/v1/users?role=admin" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
   

2. Pagination

   • Use limit and offset parameters to paginate results.
   • Example: Fetching the first 10 users.

   curl -X GET "https://api.wayvo.ai/v1/users?limit=10&offset=0" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
   

Handling Responses

1. Success Responses

   • A successful request returns a 2xx status code.
   • Example: A successful GET request.

   {
     "status": "success",
     "data": [ ... ]
   }
   

2. Error Responses

   • An error request returns a 4xx or 5xx status code.
   • Example: A 404 error for a resource not found.

   {
     "status": "error",
     "message": "Resource not found"
   }
   

Integrating with Applications

1. Automating Tasks

   • Use the API to automate repetitive tasks, such as user account management or data synchronization.
   • Example: Automatically creating a new project when a new user is added.

2. Integrating with Other Systems

   • Integrate Wayvo with other systems and services to enhance functionality.
   • Example: Syncing data between Wayvo and a CRM system.

3. Extending Functionality

   • Use custom scripts and API calls to extend the functionality of your Wayvo applications.
   • Example: Creating custom reports by aggregating data from multiple API endpoints.

Best Practices for Using the API

1. Rate Limiting

   • Be mindful of rate limits to avoid hitting the API too frequently.
   • Implement retry logic with exponential backoff to handle rate limit errors gracefully.

2. Error Handling

   • Implement robust error handling in your application to manage API errors.
   • Use error messages to debug issues and improve API request reliability.

3. Security

   • Ensure all API requests are made over HTTPS to encrypt data in transit.
   • Securely store and manage API keys and tokens, avoiding hardcoding them in your source code.

Next Steps

With an understanding of how to use the API, you can start building powerful integrations and automations. Explore our guides on Integration with External Services and Scripting and Custom Code to further enhance your applications.

For more advanced usage, check out our Advanced Features section.