Skip to main content

Splashify Pro API

Project description

Splashify Pro — Python SDK

PyPI Python docs license

Official Python SDK for the Splashify Pro API — send WhatsApp messages, transactional emails, manage contacts and conversations, and fire Meta Conversions events from your Python backend.

Install

pip install splashifypro

Requires Python 3.9+.

Get your API key

  1. Sign in to your Splashify Pro account at app.splashifypro.com. No account yet? Sign up free.

  2. Open the Settings dialog (gear icon, top right) → click the Developer tile. Direct link: app.splashifypro.com/settings/developer

  3. Under API Keys, click Generate Secret Key.

  4. Copy the key shown (starts with sk_live_…) and store it somewhere secure — it's shown only once. If you lose it, generate a new one and the old one stops working.

  5. Use it as the SPLASHIFY_API_KEY environment variable in your app. Never commit it to git or paste it into client-side code — the key carries full account access.

Tip: Set up a webhook URL on the same page to receive delivery / read receipts and inbound message events.

Authentication

The SDK uses HTTP Basic with the API key as the username:

import os
from splashifypro import Configuration, ApiClient
from splashifypro.api import MessagesApi

config = Configuration(username=os.environ["SPLASHIFY_API_KEY"])
client = ApiClient(config)

messages = MessagesApi(client)

Quickstart — send a WhatsApp text

result = messages.public_message_post(
    body={
        "type": "Text",
        "countryCode": "+91",
        "phoneNumber": "9999999999",
        "data": {"message": "Hi! Thanks for reaching out 👋"},
    }
)

print(result["id"])  # message_id — use to poll status / correlate webhooks

Send a WhatsApp template

messages.public_message_post(body={
    "type": "Template",
    "countryCode": "+91",
    "phoneNumber": "9999999999",
    "template": {
        "name": "order_confirmation",
        "languageCode": "en",
        "bodyValues": ["Sayan", "ORD-1042", "₹1,499"],
        "buttonValues": {"0": ["https://shop.example.com/orders/1042"]},
    },
})

Send a transactional email

Requires a verified sender domain. Set up at https://app.splashifypro.com/settings/email-domain.

from splashifypro.api import EmailApi

email = EmailApi(client)

email.public_email_send_post(body={
    "to": "customer@example.com",
    "subject": "Your receipt for Order #1042",
    "html": "<h1>Thanks!</h1><p>Order #1042 confirmed.</p>",
    "text": "Thanks! Order #1042 confirmed.",
    "from_email": "billing@yourdomain.com",
    "from_name": "Acme Inc.",
})

Available APIs

Class What it does
MessagesApi Send WhatsApp messages (text, template, media, interactive)
EmailApi Send transactional + templated emails
ContactsApi List + filter contacts
ConversationsApi Assign chats to team members
MetaConversionsApi Fire Meta Pixel / Conversions API events

Full reference, request/response shapes, and per-endpoint examples: https://docs.splashifypro.com/public-api

Async usage

The SDK is sync by default. For async workloads, run synchronous calls in a thread pool:

import asyncio

result = await asyncio.to_thread(
    messages.public_message_post,
    body={"type": "Text", "countryCode": "+91", "phoneNumber": "9999999999",
          "data": {"message": "Hello!"}},
)

Rate limits

Per-key limits depend on your plan tier. Hitting the limit returns HTTP 429 — the response body includes Retry-After. Tier and current consumption are visible at https://app.splashifypro.com/settings/developer.

Error handling

from splashifypro.exceptions import ApiException

try:
    result = messages.public_message_post(body={...})
except ApiException as e:
    print(f"HTTP {e.status}: {e.body}")

Support

License

MIT


This SDK is auto-generated from the official OpenAPI specification. Pull requests for SDK-side improvements (typing, ergonomic wrappers, async helpers, etc.) are welcome; underlying API changes should be filed against the documentation site.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

splashifypro-0.1.0.tar.gz (39.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

splashifypro-0.1.0-py3-none-any.whl (54.2 kB view details)

Uploaded Python 3

File details

Details for the file splashifypro-0.1.0.tar.gz.

File metadata

  • Download URL: splashifypro-0.1.0.tar.gz
  • Upload date:
  • Size: 39.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for splashifypro-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7e587debf64494a80c1dd50e81834d9dc2210b9ef78cc7ac3e80bb6bd547d4ee
MD5 f24f20fb2763457f174c34127a9c4085
BLAKE2b-256 4924aa3b3cb19d662962702465a9328a3f7efb2832b5aac1fb7930d71d4a3de8

See more details on using hashes here.

File details

Details for the file splashifypro-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: splashifypro-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 54.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for splashifypro-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 05a327b39f090b99e97fa68c796729b61a6a34cef38492a9b5da0cbae91608df
MD5 529f0ff3f0e7672426e87c454865a87e
BLAKE2b-256 a8dc5d52ec3679a524d434842935fadfea8ec5e5edf30c880f092d376ba267e9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page