API Integration

API Management - API Integration & Access


  1. API Integration & Access allows your application or software to connect directly with Sparklebot using a set of secure and well-designed interfaces (APIs). This means:
  2. Securely extend your application's functionality Add new features or automate tasks in own app by using Sparklebot API without compromising security.
  3. Robust API The API is strong, reliable, and built to handle various operations smoothly.
  4. Seamless data exchange Data flows effortlessly back and forth between your system and Sparklebot, keeping everything up to date automatically.
  5. Custom integrations Create unique connections tailored to your specific business needs, linking Sparklebot with other tools or platforms you use.
  6. Programmatic access to core resources Instead of using a manual interface, you can control and interact with important parts of Sparklebot (like contacts, messages, templates) through code, making workflows faster and more efficient.


Swagger Api Document : https://sparklebot.in/swagger


Overview

This section enables users to:

  1. Enable or disable API access
  2. Generate and manage API tokens
  3. View API endpoint information
  4. Set access permissions (Token Abilities)


Enabling API Access

StepDescription
1. Enable API AccessToggle the switch to enable API access on the settings page.
2. Generate API TokenClick Generate New Token to create a new API authentication token.
3. Copy API Base URLCopy the base URL for API calls, usually: https://sparklebot.in/api/v1/
4. Note Tenant SubdomainUse your tenant subdomain (example: tester) in endpoint URLs.
5. Save ChangesSave all your changes to activate the API integration.


API Authentication

ParameterDetails
API TokenUnique token generated for your tenant; acts as your API password.
AuthenticationUse Bearer Token in the Authorization header for all API requests.

Example Request Header

Authorization: Bearer YOUR_API_TOKEN_HERE
Content-Type: application/json

API Endpoint Structure

ElementDescription
API Base URLThe root URL where all API requests are sent.
Tenant SubdomainYour unique tenant identifier, which is part of the URL path to specify your workspace.
Complete EndpointCombination of the API Base URL + Tenant Subdomain + specific resource path. Used to access different API features.

Example Endpoint for Getting WhatsApp Templates

To retrieve WhatsApp templates, use the complete endpoint like:

API Base URL: https://skarklebot.in/api/v1/
Tenant Subdomain: tester
Complete Endpoint: https://sparklebot.in/api/v1/tester/templates

api-management

Token Abilities (Permissions)

Permissions define what actions the API token can perform. Adjust carefully for security and functionality.

CategoryPermissionsDescription
ContactsCreate, Read, Update, DeleteManage contact information (add, view, modify, remove).
StatusesCreate, Read, Update, DeleteHandle status updates for contacts or campaigns.
SourcesCreate, Read, Update, DeleteManage sources of contacts or message data.
TemplatesReadAccess WhatsApp message templates for sending messages.
Message BotsReadView and manage message bot configurations.
Template BotsReadView and manage template bot configurations.
GroupsCreate, Read, Update, DeleteManage contact groups for segmented messaging.
Message SendingText Message Send, Media Message Send, Template Message SendPermission to send different types of WhatsApp messages.