Quick Start Guide

Easily integrate with the Convers8 API to manage customer interactions, send messages, and automate your WhatsApp communication. This guide walks you through creating your account, generating an API key, and setting up your first API call. 🚀

Overview

Seamlessly integrate with the Convers8 API for customer interactions, messaging, and automation. This guide helps you set up your account, generate an API key, and make your first API call.

Step 1: Login

The first step in building a seamless and user-friendly experience with the Convers8 API is creating your project. To get started, you'll need to generate an API key, which serves as a secure authentication token. This key allows your application to interact with Convers8's services and access the full range of API functionalities.

Go to your Convers8 dashboard to log in.

Step 2: Generate your API key

1. Navigate to the sidebar and click on Settings to proceed.
2. Scroll down and select the Developer API option to generate your API key
3. Click on Generate API Key
4. This will generate a unique API key tied to your account.

Copy the generated key and store it in a secure location. This will be required for all API requests.

Nice work! Now that you've generated your API key, you'll be redirected to the Home page of your Convers8 Dashboard. Next, let's create your first API call and kickstart your application!

Step 3: Make Your First API Call

Now that you have your API key, you can start making API calls to Convers8. Here's a simple example of sending a text message:

curl --request POST \
     --url https://waba-v1.convers8.africa/whatsapp/message/text \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'Content-Type: application/json' \
     --data '{
       "to": "+1234567890",
       "name": "Customer Name",
       "content": {
         "text": "Hello from Convers8!"
       }
     }'

Replace YOUR_API_KEY with the API key you generated in Step 2, and update the phone number and name as needed.

Security Guidelines

Your API key is a sensitive piece of information that should be treated like a password. Here are a few tips to keep it safe:

• Never hard-code your API key in your codebase. Use environment variables or a secrets manager.
• Avoid sharing your API key publicly, and be cautious when sharing code or documentation that may reveal it.
• Regularly rotate your API keys, especially if you suspect they may have been compromised.

Next Steps

Now that you've sent your first message, you can explore the various API endpoints available in Convers8:

• Messaging: Send text, media, and interactive messages
• Templates: Create and send message templates
• Contacts: Manage your contacts
• Webhooks: Receive real-time updates

Check out the API Reference for detailed information on all available endpoints.