BAFAPI Send Email

BAFAPI Send Email 1.0.0

0
No votes yet
forum Discuss this API in the forum
production
development
https://apigateway.bankalfalah.com/bankalfalah/sb

Paths

/v1

post /v1
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
OAuth
OAuth
(oauth2 application)

OAuth Authentication

Token URL
https://apigateway.bankalfalah.com/bankalfalah/sb/oauthproviderapi/oauth2/token
Scopes
GetToken
RequestBody
Required in body
object
RequestData
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Success

Response Body
500

Error

Error Response
Example Request
curl --request POST \
  --url https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1 \
  --header 'accept: application/json' \
  --header 'authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --header 'x-ibm-client-id: REPLACE_THIS_KEY' \
  --header 'x-ibm-client-secret: REPLACE_THIS_KEY' \
  --data '{"ChannelId":"1010","ToEmailAddress":"abcd@bankalfalah.com","Cc":"muhammad.ali","Bcc":"","Subject":"Leave Request","Body":"Require Leaves","Attachment":{"ContentName":"","ContentType":"","ContentValue":""}}'
require 'uri'
require 'openssl'
require 'net/http'

url = URI("https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER

request = Net::HTTP::Post.new(url)
request["x-ibm-client-id"] = 'REPLACE_THIS_KEY'
request["x-ibm-client-secret"] = 'REPLACE_THIS_KEY'
request["authorization"] = 'Bearer REPLACE_BEARER_TOKEN'
request["content-type"] = 'application/json'
request["accept"] = 'application/json'
request.body = "{\"ChannelId\":\"1010\",\"ToEmailAddress\":\"abcd@bankalfalah.com\",\"Cc\":\"muhammad.ali\",\"Bcc\":\"\",\"Subject\":\"Leave Request\",\"Body\":\"Require Leaves\",\"Attachment\":{\"ContentName\":\"\",\"ContentType\":\"\",\"ContentValue\":\"\"}}"

response = http.request(request)
puts response.read_body
import http.client

conn = http.client.HTTPSConnection("apigateway.bankalfalah.com")

payload = "{\"ChannelId\":\"1010\",\"ToEmailAddress\":\"abcd@bankalfalah.com\",\"Cc\":\"muhammad.ali\",\"Bcc\":\"\",\"Subject\":\"Leave Request\",\"Body\":\"Require Leaves\",\"Attachment\":{\"ContentName\":\"\",\"ContentType\":\"\",\"ContentValue\":\"\"}}"

headers = {
    'x-ibm-client-id': "REPLACE_THIS_KEY",
    'x-ibm-client-secret': "REPLACE_THIS_KEY",
    'authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "application/json",
    'accept': "application/json"
    }

conn.request("POST", "/bankalfalah/sb/bafapi-sendemail/v1", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"ChannelId\":\"1010\",\"ToEmailAddress\":\"abcd@bankalfalah.com\",\"Cc\":\"muhammad.ali\",\"Bcc\":\"\",\"Subject\":\"Leave Request\",\"Body\":\"Require Leaves\",\"Attachment\":{\"ContentName\":\"\",\"ContentType\":\"\",\"ContentValue\":\"\"}}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Bearer REPLACE_BEARER_TOKEN",
    "content-type: application/json",
    "x-ibm-client-id: REPLACE_THIS_KEY",
    "x-ibm-client-secret: REPLACE_THIS_KEY"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ChannelId\":\"1010\",\"ToEmailAddress\":\"abcd@bankalfalah.com\",\"Cc\":\"muhammad.ali\",\"Bcc\":\"\",\"Subject\":\"Leave Request\",\"Body\":\"Require Leaves\",\"Attachment\":{\"ContentName\":\"\",\"ContentType\":\"\",\"ContentValue\":\"\"}}");
Request request = new Request.Builder()
  .url("https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1")
  .post(body)
  .addHeader("x-ibm-client-id", "REPLACE_THIS_KEY")
  .addHeader("x-ibm-client-secret", "REPLACE_THIS_KEY")
  .addHeader("authorization", "Bearer REPLACE_BEARER_TOKEN")
  .addHeader("content-type", "application/json")
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();
// Install request by running "npm install --save request"
var request = require("request");

var options = { method: 'POST',
  url: 'https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1',
  headers: 
   { accept: 'application/json',
     'content-type': 'application/json',
     authorization: 'Bearer REPLACE_BEARER_TOKEN',
     'x-ibm-client-secret': 'REPLACE_THIS_KEY',
     'x-ibm-client-id': 'REPLACE_THIS_KEY' },
  body: 
   { ChannelId: '1010',
     ToEmailAddress: 'abcd@bankalfalah.com',
     Cc: 'muhammad.ali',
     Bcc: '',
     Subject: 'Leave Request',
     Body: 'Require Leaves',
     Attachment: { ContentName: '', ContentType: '', ContentValue: '' } },
  json: true };

request(options, function (error, response, body) {
  if (error) return console.error('Failed: %s', error.message);

  console.log('Success: ', body);
});

import Foundation

let headers = [
  "x-ibm-client-id": "REPLACE_THIS_KEY",
  "x-ibm-client-secret": "REPLACE_THIS_KEY",
  "authorization": "Bearer REPLACE_BEARER_TOKEN",
  "content-type": "application/json",
  "accept": "application/json"
]
let parameters = [
  "ChannelId": "1010",
  "ToEmailAddress": "abcd@bankalfalah.com",
  "Cc": "muhammad.ali",
  "Bcc": "",
  "Subject": "Leave Request",
  "Body": "Require Leaves",
  "Attachment": [
    "ContentName": "",
    "ContentType": "",
    "ContentValue": ""
  ]
]

let postData = NSJSONSerialization.dataWithJSONObject(parameters, options: nil, error: nil)

var request = NSMutableURLRequest(URL: NSURL(string: "https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1")!,
                                        cachePolicy: .UseProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.HTTPMethod = "POST"
request.allHTTPHeaderFields = headers
request.HTTPBody = postData

let session = NSURLSession.sharedSession()
let dataTask = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? NSHTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "accept: application/json");
headers = curl_slist_append(headers, "content-type: application/json");
headers = curl_slist_append(headers, "authorization: Bearer REPLACE_BEARER_TOKEN");
headers = curl_slist_append(headers, "x-ibm-client-secret: REPLACE_THIS_KEY");
headers = curl_slist_append(headers, "x-ibm-client-id: REPLACE_THIS_KEY");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"ChannelId\":\"1010\",\"ToEmailAddress\":\"abcd@bankalfalah.com\",\"Cc\":\"muhammad.ali\",\"Bcc\":\"\",\"Subject\":\"Leave Request\",\"Body\":\"Require Leaves\",\"Attachment\":{\"ContentName\":\"\",\"ContentType\":\"\",\"ContentValue\":\"\"}}");

CURLcode ret = curl_easy_perform(hnd);
var client = new RestClient("https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1");
var request = new RestRequest(Method.POST);
request.AddHeader("accept", "application/json");
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "Bearer REPLACE_BEARER_TOKEN");
request.AddHeader("x-ibm-client-secret", "REPLACE_THIS_KEY");
request.AddHeader("x-ibm-client-id", "REPLACE_THIS_KEY");
request.AddParameter("application/json", "{\"ChannelId\":\"1010\",\"ToEmailAddress\":\"abcd@bankalfalah.com\",\"Cc\":\"muhammad.ali\",\"Bcc\":\"\",\"Subject\":\"Leave Request\",\"Body\":\"Require Leaves\",\"Attachment\":{\"ContentName\":\"\",\"ContentType\":\"\",\"ContentValue\":\"\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Example Response
POST https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1
{
  "Response": "true"
}
Try this operation
https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1
Login to test this API.
GetToken
content-type
accept

Definitions 

{
    "type": "object",
    "properties": {
        "ChannelId": {
            "type": "string"
        },
        "ToEmailAddress": {
            "type": "string"
        },
        "Cc": {
            "type": "string"
        },
        "Bcc": {
            "type": "string"
        },
        "Subject": {
            "type": "string"
        },
        "Body": {
            "type": "string"
        },
        "Attachment": {
            "type": "object",
            "properties": {
                "ContentName": {
                    "type": "string"
                },
                "ContentType": {
                    "type": "string"
                },
                "ContentValue": {
                    "type": "string"
                }
            }
        }
    },
    "example": {
        "ChannelId": "1010",
        "ToEmailAddress": "abcd@bankalfalah.com",
        "Cc": "muhammad.ali",
        "Bcc": "",
        "Subject": "Leave Request",
        "Body": "Require Leaves",
        "Attachment": {
            "ContentName": "",
            "ContentType": "",
            "ContentValue": ""
        }
    },
    "required": [
        "Attachment",
        "Subject",
        "Bcc",
        "Body",
        "Cc",
        "ChannelId",
        "ToEmailAddress"
    ]
}
              
{
    "type": "object",
    "properties": {
        "ResponseCode": {
            "type": "string"
        },
        "ResponseDesc": {
            "type": "string"
        }
    },
    "example": {
        "ResponseCode": "99",
        "ResponseDesc": "Failed"
    }
}
              
{
    "type": "object",
    "properties": {
        "Response": {
            "type": "string"
        }
    },
    "example": {
        "Response": "true"
    }
}