# Fast Email Sending & OTP Verification API - Complete Technical Documentation ## Table of Contents 1. [Introduction](#introduction) 2. [Authentication](#authentication) 3. [Base URL](#base-url) 4. [Architecture & Workflow](#architecture--workflow) 5. [API Endpoints](#api-endpoints) - [Send Plain Text Email](#send-plain-text-email) - [Send HTML Email](#send-html-email) - [Send OTP (One-Time Password)](#send-otp-one-time-password) - [Get Supported Languages](#get-supported-languages) 6. [Integration Examples](#integration-examples) 7. [Error Handling](#error-handling) 8. [Best Practices](#best-practices) --- ## Introduction Welcome to the official documentation for the **Fast Email Sending & OTP Verification API**. This microservice is engineered for high-throughput, low-latency email delivery and secure multi-language OTP (One-Time Password) generation (Send mail). Designed for developers, this API abstracts the complexities of SMTP servers, MIME types, and character encoding, allowing you to integrate robust email capabilities into your application with simple RESTful JSON calls. ### Key Features - **Instant Delivery:** Optimized routing for transactional emails. - **HTML Support:** Full rendering support for rich-text emails, newsletters, and alerts. - **Multilingual OTP:** Built-in templates for verification codes in English (EN), French (FR), Spanish (ES), and Malagasy (MG). - **Zero-Config:** No SMTP setup required; just authenticate via RapidAPI and send. --- ## Authentication This API is hosted on the RapidAPI marketplace. To authenticate, you must include the following headers in every request: | Header | Value | Description | | :--- | :--- | :--- | | `X-RapidAPI-Key` | `YOUR_API_KEY` | Your unique secret key provided by RapidAPI. | | `X-RapidAPI-Host` | `fast-email-sending-otp-verification.p.rapidapi.com` | The host address of the API. | > **Security Note:** Never expose your `X-RapidAPI-Key` in client-side code (browsers, mobile apps). Always route requests through your own backend server. --- ## Base URL All endpoints are relative to the following base URL: ``` https://fast-email-sending-otp-verification.p.rapidapi.com ``` --- ## Architecture & Workflow The API operates on a stateless REST architecture. 1. **Email Sending:** The client sends a JSON payload containing the recipient and content. The server processes the queue and dispatches via a high-reputation SMTP relay. 2. **OTP Flow:** - Client requests `/send_opt`. - API generates a cryptographically secure 6-digit code. - API sends the code via email to the user in the requested language. - API returns the code in the JSON response to your backend. - **Verification Logic:** Your backend must store this code (e.g., in Redis or a Session) and compare it against the input provided by the user in your UI. --- ## API Endpoints ### 1. Send Plain Text Email Used for system notifications, simple alerts, and textual communication. - **Endpoint:** `/send_mail` - **Method:** `POST` - **Content-Type:** `application/json` #### Request Body Schema ```json { "email": "string (required) - Recipient email address", "texte": "string (required) - The body content of the email" } ``` #### Example Request ```bash curl --request POST \ --url https://fast-email-sending-otp-verification.p.rapidapi.com/send_mail \ --header 'Content-Type: application/json' \ --header 'X-RapidAPI-Host: fast-email-sending-otp-verification.p.rapidapi.com' \ --header 'X-RapidAPI-Key: YOUR_API_KEY' \ --data '{"email":"user@example.com","texte":"Welcome to our platform. Please update your profile."}' ``` #### Success Response (200 OK) ```json { "message": "Email envoyé avec succès" } ``` --- ### 2. Send HTML Email Used for marketing campaigns, receipts, and branded communication. Supports inline CSS. - **Endpoint:** `/send_html` - **Method:** `POST` - **Content-Type:** `application/json` #### Request Body Schema ```json { "email": "string (required) - Recipient email address", "html": "string (required) - Raw HTML string" } ``` #### Example Request ```json { "email": "customer@example.com", "html": "

Invoice Paid

Thank you for your business.

" } ``` #### Success Response (200 OK) ```json { "message": "Email HTML envoyé avec succès" } ``` --- ### 3. Send OTP (One-Time Password) Generates a 6-digit code and emails it to the user. The response includes the code for server-side verification. - **Endpoint:** `/send_opt` - **Method:** `POST` - **Content-Type:** `application/json` #### Request Body Schema ```json { "email": "string (required) - Recipient email address", "language": "string (required) - Language code (EN, FR, ES, MG)" } ``` #### Supported Language Codes - `EN`: English - `FR`: French - `ES`: Spanish - `MG`: Malagasy #### Example Request ```bash curl --request POST \ --url https://fast-email-sending-otp-verification.p.rapidapi.com/send_opt \ --header 'Content-Type: application/json' \ --header 'X-RapidAPI-Key: YOUR_API_KEY' \ --data '{"email":"user@gmail.com","language":"en"}' ``` #### Success Response (200 OK) ```json { "message": "OTP envoyé avec succès", "otp": "818680" } ``` **Implementation Note:** Upon receiving this response, your server should hash the `otp` value (e.g., using bcrypt) and store it temporarily associated with the user's session. Do not send this code back to the client/frontend in the HTTP response. --- ### 4. Get Supported Languages Retrieves the list of languages currently supported for OTP templates. - **Endpoint:** `/opt_langue` - **Method:** `GET` #### Example Request ```bash curl --request GET \ --url https://fast-email-sending-otp-verification.p.rapidapi.com/opt_langue \ --header 'X-RapidAPI-Key: YOUR_API_KEY' ``` #### Success Response (200 OK) ```json { "languages": ["MG", "FR", "EN", "ES"] } ``` --- ## Integration Examples ### Python (Requests) ```python import requests url = "https://fast-email-sending-otp-verification.p.rapidapi.com/send_html" payload = { "email": "target@example.com", "html": "

Hello World

This is a test.

" } headers = { "content-type": "application/json", "X-RapidAPI-Key": "YOUR_API_KEY", "X-RapidAPI-Host": "fast-email-sending-otp-verification.p.rapidapi.com" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ### Node.js (Axios) ```javascript const axios = require('axios'); const options = { method: 'POST', url: 'https://fast-email-sending-otp-verification.p.rapidapi.com/send_opt', headers: { 'content-type': 'application/json', 'X-RapidAPI-Key': 'YOUR_API_KEY', 'X-RapidAPI-Host': 'fast-email-sending-otp-verification.p.rapidapi.com' }, data: {email: 'user@example.com', language: 'fr'} }; axios.request(options).then(function (response) { console.log(response.data); // Output: { message: 'OTP envoyé avec succès', otp: '123456' } }).catch(function (error) { console.error(error); }); ``` --- ## Error Handling The API uses standard HTTP status codes to indicate the success or failure of an API request. | Status Code | Description | | :--- | :--- | | **200** | Success. The email has been queued or sent. | | **400** | Bad Request. Missing parameters (e.g., missing 'email' field) or invalid JSON format. | | **401** | Unauthorized. Invalid or missing X-RapidAPI-Key. | | **429** | Too Many Requests. You have exceeded your rate limit. | | **500** | Internal Server Error. Please contact support. | --- ## Best Practices 1. **Validation:** Always validate email addresses on your client side before sending them to the API to reduce unnecessary API calls. 2. **Rate Limiting:** Respect the rate limits associated with your RapidAPI subscription tier to avoid 429 errors. 3. **OTP Security:** When using `/send_opt`, ensure the `otp` returned in the response is stored securely on your server. Set a short expiration time (e.g., 5 minutes) for the OTP validity in your application logic. 4. **HTML Content:** Avoid using complex JavaScript or external CSS files in the `/send_html` body. Use inline CSS for maximum compatibility across email clients (Gmail, Outlook, Yahoo).