Essential Configurations

There are bound services like the Payment Services (Vodacom Tanzania and Airtel Tanzania), Ticketing Service(Trello API), Critical Logging notification(Slack Channel), WebSocket(Pusher), etc. if you plan to get your payments through these services you need to change/edit following files/configurations

Mobile Payment Configurations - Vodacom

1. ips array element in services.php. The file is located under app/config/. The element ips holds a list of authorized IP-addresses that are allowed to send transaction data.

2. Following changes should be done in the .env file

   VODACOM_SPID=YOUR-SPID
   VODACOM_SPPASSWORD="YOUR-PASSWORD"
   VODACOM_REQUEST_URL="END-POINT WHERE YOU CONFIRM THE TRANSACTION"
   VODACOM_BROKER_CRT="LOCATION-OF-.CRT-FILE"
   VODACOM_SLL_KEY="LOCATION-OF-.KEY-FILE"
   VODACOM_CERTIFICATE_AUTHORITY="LOCATION-OF-.CER-FILE"
   VODACOM_SSL_CERT="LOCATION-OF-.PEM-FILE"

Mobile Payment Configurations - Airtel

When we set up the second payment provider in our live system, we were not that experienced by setting up VPN Tunnels that's why we go with the idea 'one tunnel per host`. Thatswhy the airtel payment integration is on a separate project for now. We're planning to migrate it into this project soon.

--> The project link comes as soon as we uploaded the project to GitHub <--

Change the api_user, api_password, and ips in services.php

'airtel' => [
      'request_url' => env('AIRTEL_REQUEST_URL'),
      'api_user' => 'YOUR-USER',
      'api_password' => 'YOUR-PASSWORD',
      'ips' => [
          'ALLOWED_IPS TO SEND YOU TRANSACTION DATA'
      ],
  ],

The following change should be done in the .env file

AIRTEL_REQUEST_URL="AIRTEL SERVICE URL"

STS Meter Configuration

Currently, the system supports only CALIN-STS meters. To be able to communicate with Calin and generate STS-Tokens, the following changes should be done;

1. Your key and the endpoint where you create those tokens.

   CALIN_KEY="CALIN-KEY"
   CALIN_CLIENT_URL="CALIN-CLIENT-URL"

2. If you have meters which can send their consumption data to CALIN's server please fill the below-listed variables too

   METER_DATA_URL="REMOTE-METER-READING-URL"
   METER_DATA_KEY="METER-READING-KEY"
   METER_DATA_USER="METER-READING-USER"

Pusher(Web Socket)

Pusher is used to notify your admins when a new ticket is been created.

PUSHER_APP_ID="PUSHER-APP-ID"
PUSHER_APP_KEY="PUSHER-KEY"
PUSHER_APP_SECRET="PUSHER-APP-SECRET"
PUSHER_APP_CLUSTER="YOUR-CLUSTER ex. eu"

Slack

Slack is the current critical logging service that alerts the admins when something went wrong. Like a transaction is been canceled.

LOG_SLACK_WEBHOOK_URL="SLACK-WEBHOOK-URL"

Setup Sms Communication

Configuration for BongoLive

WARNING

The Bongo API integration on our system is not been maintained since early 2019. Proceed with caution.

Firstly, you have to uncomment these lines in app/Providers/AppServiceProvider.php. Because the default SMSProvider is the 2nd option above.

//$this->app->singleton('SmsProvider', function ($app) {
       //   return new \App\Sms\Bongo();
       //});

After that, change the following configuration

'bongo' => [
           'url' => 'http://www.bongolive.co.tz/api/sendSMS.php',
           'sender' => 'SENDER_NUMBER',
           'username' => 'USER NAME',
           'password' => 'PASSWORD',
           'key' =>'KEY',
       ],

Configuration for SMS-Gateway Application

INFO

Please read the SMS-Gateway documentation before you continue

To lower the costs of the system we are using the following application to send and receive SMSes over that application. To be able to use the application you need to assign following configuration values in services.php

You are not forced to use our inhouse solution for SMS communication. You can change the SmsProvider easily in app/Providers/AppServiceProvider.php

$this->app->singleton('SmsProvider', static function ($app) {
           return new AndroidGateway();
       });

'sms' => [

        'android' => [
            'url' => 'https://fcm.googleapis.com/fcm/send',
            'token' => 'FIREBASE_TOKEN',
            'key' => 'PHONE_KEY',
        ],
        'callback' => 'https://localhost:8000/api/sms/%s/confirm',
    ],

NOTE

Dont forget to change the callback variable to a globaly reachable domain

Change Predefined SMS Text

To change the predefined SMS texts, please edit app/Sms/SmsTypes.php

Email

To be able to send E-Mails please edit following configuration variables

return [
    'host' => '', //your host to send through
    'smtp_auth' => true, // enable SMTP authentication
    'username' => '',// SMTP username
    'password' => '', //SMTP username
    'smtp_secure' => PHPMailer::ENCRYPTION_STARTTLS,// default is tls
    'port' => '',
    'default_sender' => '',
    'default_message' => 'Please do not reply to this email', // adds a small footer text to your email
];

There are currently two supported SMS-Gateways.

1. Inhouse SMS-Gateway Application