> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beem.africa/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get up and running with the Beem APIs in just a few minutes.

Welcome to the Beem API platform. This guide walks you through creating your account, obtaining API credentials, and making your first authenticated API request.

By the end of this guide, you'll have everything you need to start integrating any of the Beem APIs, including SMS, OTP, Contacts, Airtime, and Moja.

***

## Prerequisites

Before you begin, ensure you have:

* A free Beem account.
* Access to the Beem Dashboard.
* An active API product (SMS, OTP, Contacts, Moja, Airtime, etc.).
* A tool for making HTTP requests (Postman, Insomnia, cURL, or your preferred programming language).

***

## Get started

<Steps>
  <Step title="Create a Beem account">
    Create a free account from the Beem Dashboard.

    After registering, verify your email address and phone number. You'll receive a verification email — click the verification link to activate your account before signing in.
  </Step>

  <Step title="Sign in to the Dashboard">
    Log in using your email address and password.

    Once signed in, you'll have access to all Beem communication products from a single dashboard.
  </Step>

  <Step title="Choose the API you want to use">
    From the dashboard, navigate to the product you want to integrate.

    Examples include:

    * SMS
    * OTP
    * Contacts
    * Airtime
    * Moja

    Each product has its own configuration page where API credentials can be managed.
  </Step>

  <Step title="Generate your credentials">
    Open the **API Setup** or **Authentication** page for the selected product.

    Generate your credentials.

    Depending on the API, authentication is performed using either:

    * **API Key and API Secret**
    * **Access Token**

    <Warning>
      Your **API Secret** is displayed only once after it has been generated. Store it securely because it cannot be viewed again.
    </Warning>
  </Step>

  <Step title="Authenticate your requests">
    Every request to the Beem API must be authenticated.

    Most APIs support one of the following authentication methods:

    ### Basic Authentication

    Use your API credentials:

    * Username → API Key
    * Password → API Secret

    or

    ### Access Token Authentication

    Include your access token in the request header. **Do not** use a `Bearer` prefix.

    ```http theme={null}
    Authorization: your-access-token
    ```

    Refer to each API's documentation to determine which authentication methods are supported.
  </Step>

  <Step title="Make your first API request">
    You're now ready to start using the Beem APIs.

    Navigate to the API Reference for your selected product and try one of the available endpoints using the interactive API playground or your preferred API client.
  </Step>
</Steps>

***

## Authentication methods

Most Beem APIs support one or both of the following authentication methods. Use **one method per request** — not both.

<Tabs>
  <Tab title="API Key & Secret">
    Authenticate using HTTP Basic Authentication.

    * **Username:** API Key
    * **Password:** API Secret

    This method is supported by most Beem APIs.
  </Tab>

  <Tab title="Access Token">
    Pass your access token in the `Authorization` request header. **Do not** use a `Bearer` prefix.

    ```http theme={null}
    Authorization: your-access-token
    ```
  </Tab>
</Tabs>

<Info>
  **Exceptions:** [Multicountry SMS](/guides/multicountry-sms/prerequisites) uses form-based `USERNAME`/`PASSWORD` credentials. [Two Way SMS](/guides/two-way-sms/security) receives inbound callbacks rather than making authenticated outbound API calls.
</Info>

***

## Best practices

<CardGroup cols={2}>
  <Card title="Keep credentials secure">
    Never expose your API Key, API Secret, or Access Token in frontend applications or public repositories.
  </Card>

  <Card title="Rotate credentials">
    If you suspect your credentials have been compromised, generate a new API Key and Secret from the Dashboard and revoke the old credentials.
  </Card>
</CardGroup>

***

## Next steps

Now that your account is configured, explore the API documentation for the product you're integrating.

<CardGroup cols={2}>
  <Card title="API Guides" icon="book-open">
    Learn how each Beem product works before integrating.
  </Card>

  <Card title="API Reference" icon="code">
    Try endpoints directly from the interactive OpenAPI documentation.
  </Card>
</CardGroup>

***

<Tip>
  Need help getting started? Contact the Beem support team at **[support@beem.africa](mailto:support@beem.africa)**.
</Tip>