https://github.com/thecompez/kavenegar

Kavenegar API Client Written In Modern C++
https://github.com/thecompez/kavenegar

Last synced: 11 months ago
JSON representation

Kavenegar API Client Written In Modern C++

• Host: GitHub
• URL: https://github.com/thecompez/kavenegar
• Owner: TheCompez
• License: mit
• Created: 2019-11-30T21:19:32.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-10-31T18:37:17.000Z (over 5 years ago)
• Last Synced: 2024-11-19T20:53:05.318Z (over 1 year ago)
• Language: C++
• Homepage: https://kavenegar.com/rest.html
• Size: 229 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Kavenegar API Client Written In Modern C++

[![Total alerts](https://img.shields.io/lgtm/alerts/g/Kambiz-Asadzadeh/Kavenegar.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Kambiz-Asadzadeh/Kavenegar/alerts/)

[![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/Kambiz-Asadzadeh/Kavenegar.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Kambiz-Asadzadeh/Kavenegar/context:cpp)

![Language iso: C++](https://img.shields.io/badge/C%2B%2B-17-blue)

![Version](https://img.shields.io/badge/Version-0.6-lightgrey)

![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20macOS%20%7C%20Linux%20%7C%20iOS%20%7C%20Android%20%7C%20Web-lightgrey)

![Dependencies](https://img.shields.io/badge/dependencies-Curl%20%7C%20RapidJson-yellow)

# Kavenegar RESTful API Document

If you need to future information about API document Please visit RESTful Document

## Installation



First of all, You need to make an account on Kavenegar from Here





After that you just need to pick API-KEY up from My Account section.

 

## Building

- You need CMake tool for building source code

- Get Curl & RapidJson [Pay Attention: RapidJson is header only]

- All source code is written with Pure STL 1z (C++17)

- MSVC 2017, GCC7.x or Clang 7.x

- Add KavenegarLib.dll [on Windows], KavenegarLib.dylib [on macOS] or KavenegarLib.so [on Linux] for your project as external library.

- Import SDK common header ```#include ```

## Usage Example

```cpp

#include 

#include 

int main()

{

  //! Your Api Key

  std::string apiKey {"Your Api-Key"};

  

  //! Kavenegar Default Sender Number 

  std::string senderLine {"10004346"};

  

  //! Http/Https Request method GET/POST type [default is Get method]

  Kavenegar::Method MethodType { Kavenegar::Method::GET }; 

  Kavenegar::KavenegarApi api(MethodType ,"10004346",apiKey);

  

  //ToDo.. try catch exception handling.

  api.send("09140000000","Hi!");

  std::cout << "Result : " << api.getResult(); //JSon Output

    

  return 0;

}

```

## Contribution

Bug fixes, docs, and enhancements welcome! Please let me know kambiz.ceo@gmail.com

## **ToDo**

 * New features

 * Exception handling

 * Post method development

 * Etc...