😎Quick Start Guide

After signing up and obtaining your API key, you're ready to start interacting with buska's API. Let's walk through a simple test to ensure your API key works and you can authenticate successfully.

Testing Your API Key

To verify that your API key is valid and you can access buska's API, use the /test-api endpoint. This endpoint checks the validity of your API key and returns a success message if the authentication is successful.

Making a Test Request

You can test your API key by sending a GET request to the test endpoint. Here's how you can do it using curl from the command line:

curl -H "x-api-key: YOUR_API_KEY_HERE" https://api.buska.io/api/routes/test-api

Replace YOUR_API_KEY_HERE with your actual API key. If your API key is valid and everything is set up correctly, you will receive a response like this:

results {
  "success": true,
  "message": "Successful API key authentication!"
}

What to Expect

• Success Response: If you receive the success response, your API key is correctly configured, and you're ready to start using buska's API for your projects.

• Error Response: If you encounter an error, ensure that you've included the correct API key in your request header and that you're sending the request to the correct endpoint. Double-check your API key on your dashboard within buska.

Rate Limiting

Please note that Buska's API enforces rate limiting to ensure fair usage and protect the service from being overloaded.

For the Ultimate plan, you are now allocated 100 credits per month. As long as you have credits available, you can make API calls. Each API call consumes one credit from your available balance.

Custom plans may have different rate limits, tailored to the specific needs of your project. If you exceed your monthly credit allocation, you will receive a 429 Too Many Requests response code until your credit balance is replenished at the start of the next month at midnight UTC.

We encourage users to monitor their credit consumption to ensure they always have the necessary number of credits for their intended use. For detailed information on tracking your credit balance and how API calls are counted against your quota, please refer to our FAQ section or contact customer support.

Next Steps

Once you've successfully tested your API key, you're ready to dive deeper into what buska's API offers. Explore the various endpoints available, understand how to make requests, and start building your applications with social listening capabilities at their core.

Refer to the detailed endpoint documentation in the subsequent sections to learn more about what you can achieve with buska's API.

From tracking brand mentions across platforms to analyzing sentiment and identifying trends, buska's API provides you with the tools you need to gain insights from social listening data.