https://github.com/vincejv/m360-api-client

This library takes care of handling the API requests/responses to allow developers to focus on the business logic offered by the integration with M360's Messaging API. The goal of this client is to ensure that the integration with M360 is seamless and hassle-free. Drop us a line in the issue tracker if you feel that it can be improved!
https://github.com/vincejv/m360-api-client

api asynchronous globe java m360 m360-api reactive rest sms

Last synced: 6 months ago
JSON representation

This library takes care of handling the API requests/responses to allow developers to focus on the business logic offered by the integration with M360's Messaging API. The goal of this client is to ensure that the integration with M360 is seamless and hassle-free. Drop us a line in the issue tracker if you feel that it can be improved!

• Host: GitHub
• URL: https://github.com/vincejv/m360-api-client
• Owner: vincejv
• License: apache-2.0
• Created: 2023-08-28T20:28:47.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-02T15:22:32.000Z (over 2 years ago)
• Last Synced: 2025-02-02T19:46:37.730Z (over 1 year ago)
• Topics: api, asynchronous, globe, java, m360, m360-api, reactive, rest, sms
• Language: Java
• Homepage:
• Size: 127 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# M360 API Java Client



[![Maven Central version](https://img.shields.io/maven-central/v/com.vincejv/m360-api-client?logo=apache-maven)](https://search.maven.org/artifact/com.vincejv/m360-api-client)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/vincejv/m360-api-client/Maven%20Central%20deployment?label=CI/CD&logo=github)](https://github.com/vincejv/m360-api-client/actions?query=workflow%3A%22Maven+Central+deployment%22)

[![License](https://img.shields.io/github/license/vincejv/m360-api-client?logo=apache)](https://github.com/vincejv/m360-api-client/blob/main/LICENSE)

[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/vincejv/m360-api-client?label=commits&logo=git)](https://github.com/vincejv/m360-api-client/pulse)

[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=vincejv_m360-api-client&metric=alert_status)](https://sonarcloud.io/dashboard?id=vincejv_m360-api-client)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=vincejv_m360-api-client&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=vincejv_m360-api-client)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=vincejv_m360-api-client&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=vincejv_m360-api-client)

[![SonarCloud Bugs](https://sonarcloud.io/api/project_badges/measure?project=vincejv_m360-api-client&metric=bugs)](https://sonarcloud.io/component_measures/metric/reliability_rating/list?id=vincejv_m360-api-client)

[![SonarCloud Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=vincejv_m360-api-client&metric=vulnerabilities)](https://sonarcloud.io/component_measures/metric/security_rating/list?id=vincejv_m360-api-client)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=vincejv_m360-api-client&metric=security_rating)](https://sonarcloud.io/dashboard?id=vincejv_m360-api-client)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=vincejv_m360-api-client&metric=ncloc)](https://sonarcloud.io/dashboard?id=vincejv_m360-api-client)

Language: Java

An Open Source Client Library for Java applications to integrate and interact with

the M360 Messaging API of [m360 - Globe Business](https://www.globe.com.ph/business/sme/solutions/sms-api.html)

This library takes care of handling the API requests/responses to allow developers to

focus on the business logic offered by the integration with M360's Messaging API. The goal of this

client is to ensure that the integration with M360 is seamless and hassle-free. Drop us a line in

the issue tracker if you feel that it can be improved!

## Features

- Ready-to-use interfaces to consume M360's [Messaging API](https://www.globe.com.ph/business/sme/solutions/sms-api.html)

- Common response object

- ~~Unit and functional testing with mocked responses from the API.~~ TODO

- Asynchronous calls

## Domain Objects

This library deals with the following list of domain objects from the DVS API:

 - BroadcastResponse

 - BroadcastRequest

 - SMSRequest

## Installation & Usage

- Requires Java 17 or later

- The library is available to be installed as a Maven Dependency or Standalone Java Archive.

    1. Maven Dependency

       - Add the following dependency in your `pom.xml`

           ```xml

           

               com.vincejv

               m360-api-client

               1.0.2 

           

           ```

    2. Standalone JAR

        - Feel free to download the latest JAR with the dependencies directly from maven central [here](https://repo.maven.apache.org/maven2/com/vincejv/m360-api-client/)

        and add the jar to the classpath of your project.

  

- Create an instance from `M360ApiClient` with your basic auth keys and sender id or shortcode mask

    ```java

    import com.vincejv.m360;

    

    var m360Client = new M360ApiClient(String baseApiUrl, String appKey,

          String appSecret, String senderId)

    ```

- Start calling the M360 API!

## Basic Troubleshooting and frequently asked questions:

- Should an application create more than one `M360ApiClient`?

    

    There should be no need to do that in a single application.

## License

- [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)