Quick Start Guide to Launching the API

The purpose of this document is to provide a guide for the proper use of the Masivapp API service for sending emails. Utilizing our API offers the following benefits:

Ease of integration: It provides a standardized and structured method of communication between systems.

Scalability: By integrating the API, your application can scale more efficiently by leveraging the resources and services provided by Masiv. This allows for adaptability to changing demands without requiring significant infrastructure investments.

Extended functionality: The API offers access to a wide range of features that can enhance your application.

Collaboration and connectivity: The API enables connectivity between different systems and applications, fostering collaboration across platforms.

In summary, integrating with our API is a powerful tool that can help businesses improve their email notification processes and enhance user experience.

1. 🌎Endpoint

The following shows the URL and method where the API receives the sending requests:

Method URL
POST **https://api.masiv.masivian.com/email/v1/delivery**

2. 📋Prerequisites

The following prerequisites must be considered before sending an email:

3. 🚫 Restrictions

Sending Restrictions for Colombia (Law 2300 and RNE):

The transactional email API includes functionality to apply the sending restrictions set forth by Law 2300, also known as the "Law of Calls" for Colombia, as well as the validation of the National Registry of Exclusions (RNE). Law 2300 regulates the sending of text messages with advertising and/or collection content to limit the number of messages sent to end users, and to ensure that these are sent within permitted hours: Monday to Friday from 7:00 a.m. to 7:00 p.m., and Saturdays from 8:00 a.m. to 3:00 p.m., excluding Sundays and public holidays.

For the API to apply these restrictions, it is necessary to enable these features in the account settings. Masiv's staff has the ability to adjust the settings to activate the restrictions.

<aside> 💡

Note: Clarification on Compliance with Law 2300 and RNE Consultation

The API performs the necessary validations to ensure compliance with Law 2300 and the National Registry of Exclusions (RNE), as long as the associated restrictions and parameters are active in the account from which the requests are being made.

</aside>

4. 🔐Authentication

Basic authentication is a simple authentication scheme integrated into the HTTP protocol. To use it, send your HTTP requests with an Authorization header containing the word Basic followed by a space and a base64-encoded string corresponding to username:password, as shown below:

Name Value Description Required
Authorization Basic <Token> Basic Auth authentication header. The token must contain the structure username:password encoded in base64 and correspond to a valid Masiv user. Required

Example of a header for making API requests by encoding username:password in base64.

Authorization: Basic dXN1YXJpbzpjb250cmFzZcOxYQ==