Welcome to Salesbox's developer documentation
===========================================

.. note::
    This documentation covers the REST API integration aspects of Salesbox.

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   rest_api/overview

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   rest_api/authentication
   rest_api/endpoints
   rest_api/assets
   rest_api/campaigns
   rest_api/categories
   rest_api/contacts
   rest_api/fields
   rest_api/notifications
   rest_api/point_groups
   rest_api/reports
   rest_api/text_messages

Overview
--------

The Salesbox REST API allows you to integrate Salesbox with your applications. You can use the API to:

* Access and manage your Salesbox data
* Automate workflows
* Integrate with third-party applications
* Build custom applications

Base URL
~~~~~~~~

All API requests should be made to:

.. code-block:: text

    https://segmentai.salesbox.com.br/api

Response Format
~~~~~~~~~~~~~

All responses are returned in JSON format. A typical response looks like this:

.. code-block:: json

    {
        "status": "success",
        "data": {
            // Response data here
        }
    }

Rate Limiting
~~~~~~~~~~~

The API has rate limiting to ensure fair usage:

* 1000 requests per minute for authenticated users
* 60 requests per minute for unauthenticated requests

Error Handling
~~~~~~~~~~~~

The API uses standard HTTP response codes:

* 200: Success
* 400: Bad request
* 401: Unauthorized
* 403: Forbidden
* 404: Not found
* 429: Too many requests
* 500: Server error

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`