Pre Acquired

Before you can use all the services in fazpass, such as OTP, misscall and verification you must have merchant_key (Token) for accessing fazpass API. you can get merchant_key (Token) by registering here for our production.we will send it to you by email, you will get email for the detailed access. If you have a problem, you can ask directly for our live support here. to accessing our dashboard, you can go here for Production env

Note : You need to use merchant_key (Token) for every API / Services you use

To use Fazpass API you need authentication using merchant_key (Token) . That can be done by setting the Authorization HTTP header. Please refer to the detail below for further information about how and where the Authorization can be implemented.

Authorization: {{type}} {{Token}}
type = Bearer Token
Token = merchant_key

Integration Flow

1. Admin Side

   On the Admin side, the admin should do few things before the engineer can implement the API correctly. in this part, we will guide you, how to setup a gateway before you the engineer can integrate and use the Generate and verification API

   1. Admin login to Fazpass dashboard
   2. Admin go to proxy menu
      
   3. Admin Add new gateway
      
   4. Admin fill the form

      Field	Description
      Gateway	Your gateway name
      Channel Name	Select otp channel (misscall, SMS,email, whatsapp,etc)
      Select Provider Name	Select your desire provider e.x : Citcall
      Subject / title	user for email OTP title (will be ignored for SMS,whatsapp and miss call)
      Message	Custom your message, please ensure use “{OTP}” to insert generate OTP in between your custom message (will be ignored for miss call and official whatsapp)
      OTP Length	min 4 max 8
      Note / purpose	purpose for the gateway e.x login, register, transaction, etc
      Credential key	If you have a special price from the provider, feel free to insert a credential key here.
      Enable gateway	set gateway enable by clicking it

      
   5. Save the data

      This step for the admin is finished. and the engineer can start integration in the API side

2. Engineering Side

   On the engineering side, you as engineer will integrate Fazpass API in a view step.

   1. Login to dashboard
   2. Go to proxy menu
   3. See the gateway purpose and gateway key

      If you get the gateway key, you can start to integrate the Fazpass OTP using API generate and then validate it using API verification

      Before we jump to API, this is endpoint env for our setup

HTTP Request Endpoint

This Request Endpoint is needed for your integration process so that your system can request OTP through Fazpass services

Base URL https://api.fazpass.com/

API Request OTP

This Api will allow you to send OTP from any provider selected in the gateway with the OTP being masked. so we will generate and mask the OTP and send it to the user. and the user will verify it.

POST {base_url}/v1/otp/request

{
    "Email": "Your Email", (optional)
    "phone": "Your Phone",
    "gateway_key": "gateway from dashboard"
}
                

To use Fazpass API you need to submit a RAW JSON object to the body. The RAW JSON object takes the following properties

the url is case sensitive

Request response example for SMS

Response status

Request response example for Whatsapp

Response status

For Whatsapp official if the number is new to the agregator system, they will check if the number have an association with whatsapps or not. if the checking success, then you need to HIT AGAIN to send the OTP.

Request response example for Misscall

Response status

Request response example for Email

Response status

API Validate OTP

You will need to implement this API to verified the Requested OTP from above API

POST {base_url}/v1/otp/verify

{
  "otp_id": "your OTP ID",
  "otp":"OTP inputed from user"
}

To use Fazpass API you need to submit a RAW JSON object to the body. The RAW JSON object takes the following properties

the url is case sensitive

OTP validation for SMS,Email and Whatsapp

Response status

OTP validation for Miss Call

Response status

MISC

this section will redirect you if you have other flow implemented in your system.

If you already create an OTP generator and verification you can read this document for further information.

If you already have the verification system but you want fazpass to generate and send your OTP you can read this document for further information.

for other function in admin dashboard, you can refer to this document

we also have ui/ux suggestion in the bellow section of this document

UI / UX SUGGESTION

Our services will provide many service methods for you to verify your user. As for flexibility, there will be some different methods in the UI or UX for your application. In this section we will give some suggestions for the UI or UX of the application regardless of the OTP verification based on what method you will use.

Our Services may consist of SMS, Whatsapp, miss call, email and other user verification methods. these services need different UI in the implementation especially for miss calls.

How to determine what UI or UX to use? In the previous section, after your engineer integrates the “Request API” every time you call the API, your system will get a response like shown below.

In the response you will see our services will give you response parameters such as ID, OTP(masked), OTP_lenght and CHANNEL. As you can see, the CHANNEL parameter will be filled with “what method you use for verification” and you will be able to determine what kind of UI or UX to use based on what channel.

Channel response list

Custome Personalize Messages

if you need to more personalize message such as you need to add name by adding “parameter_1” to your api and dashboard like what shown bellow

POST {base_url}/v1/otp/request

{
  "Email": "Your Email", (can be empty)
  "phone": "Your Phone",  (can be empty)
  "gateway_key": "gateway from dashboard"
  "params": [
        {
            "tag": "parameter_1",(optional)
            "value": "value 1"
        },
        {
            "tag": "parameter_2", (optional)
            "value": "value 2"
        }
    ]
}

Note : this custom personalize will only work for sms, email and WA long number

UI suggest

For miss call we suggest following ui to implement

For sms / WA we suggest following ui to implement

or Email we suggest following ui to implement

Pre Acquired

Before you can use all the services in fazpass, such as OTP, misscall and verification you must have merchant_key (Token) for accessing fazpass API. you can get merchant_key (Token) by registering here for our production.we will send it to you by email, you will get email for the detailed access. If you have a problem, you can ask directly for our live support here. to accessing our dashboard, you can go here for Production env

Note : You need to use merchant_key (Token) for every API / Services you use

To use Fazpass API you need authentication using merchant_key (Token) . That can be done by setting the Authorization HTTP header. Please refer to the detail below for further information about how and where the Authorization can be implemented.

Authorization: {{type}} {{Token}}
type = Bearer Token
Token = merchant_key

HTTP Send Endpoint

This Request Endpoint is needed for your integration process so that your system can request message through Fazpass services

Production https://api.fazpass.com/

API Blasting message

Before you guys can use api send, you must set a gateway in the dashboard

1. Admin Side

   On the Admin side, the admin should do few things before the engineer can implement the API correctly. in this part, we will guide you, how to setup a gateway before you the engineer can integrate and use the Generate and verification API

   1. Admin login to Fazpass dashboard
   2. Admin go to proxy menu
      
   3. Admin Add new gateway
      
   4. Admin fill the form

      Field	Description
      Gateway	Your gateway name
      Channel Name	Select otp channel (misscall, SMS,email, whatsapp,etc)
      Select Provider Name	Select your desire provider e.x : Citcall
      Subject / title	user for email OTP title (will be ignored for SMS,whatsapp and miss call)
      Message	Custom your message, please ensure use “{OTP}” to insert generate OTP in between your custom message (will be ignored for miss call and official whatsapp)
      OTP Length	min 4 max 8
      Note / purpose	purpose for the gateway e.x login, register, transaction, etc
      Credential key	If you have a special price from the provider, feel free to insert a credential key here.
      Enable gateway	set gateway enable by clicking it

      

      You can write HTML script directly, or upload a template file. make sure to put “<HTML>”,” </HTML>”,” <BODY>”,”</BODY>” tag to ensure the email will be rendered in all platform

   5. Save the data

      This step for the admin is finished. and the engineer can start integration in the API side

2. Engineering Side

   On the engineering side, you as engineer will integrate Fazpass API in a view step.

   1. Login to dashboard
   2. Go to proxy menu
   3. See the gateway purpose and gateway key

      If you get the gateway key, you can start to integrate the Fazpass OTP using API generate and then validate it using API verification

      Before we jump to API, this is endpoint env for our setup

NOTE : THIS METHOD NOT SUPPORT FOR MISSCALL

HTTP Request Endpoint

POST {base_url}/v1/message/send
                
{
  "phone": "085726451070",//can be empty or not use
  "email": "sigit.hnadi@gmail.com",
  "gateway_key": "9c1abaff-ecdf-4b03-bf55-fa6f9be47b95",
  "params": [
      {
          "tag": "parameter_1",
          "value": "sigit"
      },
      {
          "tag": "parameter_2",
          "value": "Anda berhak mendapatkan promosi menarik dari kammi berupa promosi potongan harga sebesar 50%, berlaku sampai desember 2022"
      }
  ]
}

To use Fazpass API you need to submit a RAW JSON object to the body. The RAW JSON object takes the following properties

the url is case sensitive

Case and exsamples

1. you have static text with dynamic variable such as “name”, “promo”

   

   you can fill “parameter_1” with your users “name” and the “parameter_2” can be filled with your promotional content

2. you need a completely dynamic long text send from your side

   

   you can just put the “parameter_1” in our dashboard and you can fill the variable with your own word

Send Long Message SMS / Whatsapp Long number / Email

Response status

Channel response list

Looping And HTML Render For Email (Additional)

for looping case you can add following code in your html template or you can download the full example code here.

for custom template using HTML / css function as array data, you can refer here.

API hit with HTML tag in json data

{
  "email": "ikwanpuji90@gmail.com",
  "gateway_key": "58982aaa-edf3-4e2a-824c-5f65dee33ce5",
  "params": [
  {
    "tag": "loop",
    "data": [
      {
        "header": [
          {
            "site_url": "http://localhost/bhi/?utm_source=system&utm_medium=email&utm_campaign=Thank you for shopping with Beauty Haul Indo!",
            "site_logo": "http://localhost/bhi/assets/logo_beautyhaul.png"
          }
        ]
      },
      {
        "footer": [
          {
            "ig_logo": "http://localhost/bhi/assets/ig.png",
            "tiktok_logo": "http://localhost/bhi/assets/tiktok.png",
            "fb_logo": "http://localhost/bhi/assets/fb.png",
            "yt_logo": "http://localhost/bhi/assets/yt.png",
            "line_logo": "http://localhost/bhi/assets/line2.png",
            "wa_logo": "http://localhost/bhi/assets/wa.png",
            "copyright_year": "2022",
            "contact_link": "http://localhost/bhi/contact-us?utm_source=system&utm_medium=email&utm_campaign=Thank you for shopping with Beauty Haul Indo!"
          }
        ]
      },
      {
        "payment_info": [
          {
            "va_number": "13448018955500072",
            "how_to_link": "http://localhost/bhi/how-to-order/virtual-account-bca?utm_source=system&utm_medium=email&utm_campaign=Thank you for shopping with Beauty Haul Indo!"
          }
        ]
      },
      {
        "items": [
          {
            "quantity": "20",
            "subtotal": "100.000",
            "product_variant": {
              "option": "Size",
              "value": "150ml"
            },
            "product_img": "",
            "pre_order": {
              "date": "2022-10-12"
            },
            "brand_title": "KLAIRS",
            "product_title": "Gentle Black Fresh Cleansing Oil",
            "detail_link": "http://localhost/bhi/product/detail/gentle-black-fresh-cleansing-oil?utm_source=system&utm_medium=email&utm_campaign=Thank you for shopping with Beauty Haul Indo!",
            "children": []
          }
        ]
      },
      {
        "calculation": [
          {
            "subtotal": "Rp 345.000",
            "total": "Rp 500.000",
            "discount": "",
            "cc_discount": "",
            "gc": {
              "code": "",
              "value": ""
            },
            "insurance": "",
            "loyalty_points": "",
            "wooden_crate": "",
            "gift_wrap_service": "",
            "uniq": "",
            "service_charge": ""
          }
        ]
      },
      {
        "shipping": [
          {
            "name": "da da",
            "phone": "123213",
            "address": "dada",
            "address2": "",
            "district": "Tagineri",
            "city": "Kab. Jayawijaya",
            "state": "Papua",
            "country": "Indonesia",
            "zip": "99557"
          }
        ]
      },
      {
          "web":"<h1 style='color:red;'>Sukses1</h1>",
          "web2":[
              { 
                  "a":"<h1 style='color:orange;'>Sukses2</h1>",
                  "b":"<h1 style='color:green;'>Sukses3</h1>",
                  "c":{ 
                      "d":"<h1 style='color:blue;'>Sukses4</h1>",
                      "e":"<h1 style='color:yellow;'>Sukses5</h1>"
                  }
              }
          ]
      }
    ]
  },
  {
    "tag": "parameter_1",
    "value": "Complete Your Payment"
  },
  {
    "tag": "parameter_2",
    "value": "Ikwan (ini dari parameter)"
  },
  {
    "tag": "parameter_3",
    "value": "<div>Your order has been successfully placed. Please pay before <span style=\"color:#E4002B; font-weight: 700;\">24 December 2022 14:15</span></div>"
  },
  {
    "tag": "parameter_4",
    "value": "3RWXGWU3"
  },
  {
    "tag": "parameter_5",
    "value": "Rp 500.000"
  },
  {
    "tag": "parameter_6",
    "value": ""
  },
  {
    "tag": "parameter_7",
    "value": ""
  }
]
}
              

1 loop

{{ range $key, $index := (index .Pages 0).detail }}
  <tr style="vertical-align:center;margin-top:2px;">
  <td align="center" style="width: 15%;">{{$index.nomor}} </td>
  <td align="center" style="width: 25%;">{{$index.sku}}</td> 
  <td align="center" style="width: 25%;">{{$index.qty}}</td> 
  <td align="center" style="width: 35%;">{{$index.price}}</td>
  </tr>
{{ end }}

2-n loop

// 1st array
{{ range $key, $index := (index .Pages 0).detail }}
<tr style="vertical-align:center;margin-top:2px;">
  <td align="center" style="width: 15%;">{{$index.nomor}}</td>
  <td align="center" style="width: 25%;">{{$index.sku}}</td> 
  <td align="center" style="width: 25%;">{{$index.qty}}</td> 
  <td align="center" style="width: 35%;">{{$index.price}}</td>
</tr>
{{ end }}
// sub-1st array
<tfooter>
<tr style="vertical-align:center">
  <th>Summary</th>
  <th></th>
  <th>Total</th>
  <th align="center">{{ (index (index .Pages 1).summary 0).total}}</th>
</tr>
<tr style="vertical-align:center">
    <th></th>
    <th></th>
    <th>Discount</th>
    <th align="center">{{ (index (index .Pages 1).summary 0).discount}}</th>
</tr>
</tfooter>
// 2nd array

{{ range $key, $index := (index .Pages 2).history }}
<tr style="vertical-align:center;margin-top:2px;">
  <td align="center" style="width: 15%;">{{$index.nomor}} </td>
  <td align="center" style="width: 35%;">{{$index.transaksi}}</td> 
  <td align="center" style="width: 25%;">{{$index.total}}</td> 
  <td align="center" style="width: 25%;">{{$index.point}}</td>
</tr>
{{ end }}

API json exsample for N-array

{
  "email": "sigit.handi@gmail.com",
  "gateway_key": "dfe5c18f-084f-4f15-b238-65e26b28809a",
  "params": [
      {
          "tag": "parameter_1",
          "value": "Tuan Ikwan"
      },
      {
          "tag": "payment",
          "value": "3400"
      },
      {
          "tag": "subtotal",
          "value": "2900"
      },
      {
          "tag": "shipping",
          "value": "50"
      },
      {
          "tag": "total",
          "value": "3400"
      },
      {
          "tag": "address",
          "value": "Jl. Medan Merdeka Barat No.9, RT.2/RW.3, Gambir, Kecamatan Gambir, Kota Jakarta Pusat, Daerah Khusus Ibukota Jakarta 10110"
      },
      {
          "tag": "loop",
          "data": [
             {
                 "detail":[
                      {
                          "nomor": "1",
                          "sku": "item-1",
                          "qty": "2",
                          "price": "2000"
                      },
                      {
                          "nomor": "2",
                          "sku": "item-2",
                          "qty": "1",
                          "price": "1000"
                      }
                 ]
             },
             {
                 "summary":[
                      {
                          "total": "3000",
                          "discount": "10"
                      }
                 ]
             },
             {
                 "history":[
                      {
                          "nomor": "1",
                          "transaksi": "inv/20221221/1",
                          "total": "2800",
                          "point": "10"
                      },
                      {
                          "nomor": "2",
                          "transaksi": "inv/20221201/11",
                          "total": "2900",
                          "point": "10"
                      },
                       {
                          "nomor": "3",
                          "transaksi": "inv/20221112/33",
                          "total": "3300",
                          "point": "5"
                      }
                 ]
             }
          ]
      }
  ]
}

Attachment

attachment should be base 64
maximum all attachment is 8MB / 8192KB

{
  "tag": "attach",
  "attachments":[
    {
      "fileName":"click_button.png", 
      "content": "BASE64 GENERATED STRING",
    },
    {
      "fileName": "otp_usage.xlsx",
      "content": "BASE64 GENERATED STRING",
    },
    {
      "fileName": "abstrak.pdf",
      "content": "BASE64 GENERATED STRING",
    }
  ]
}

MISC

this section will redirect you if you have other flow implemented in your system.

for other function in admin dashboard, you can refer to this document

we also have ui/ux suggestion in the bellow section of this document

Method and Payload

POST
{
  "transaction_id": "b3008bd0-92b6-496a-87df-e8cdaf904231",
  "service": "otp",
  "gateway": "9affcc7b-47d2-4cb8-9ab2-4d9ae862b5ae",
  "method": "Generate",
  "provider": "Wavecell",
  "product": "SMSOTP",
  "phone": "6285726451070",
  "token": "8489",
  "status": "DELIVERED",
  "duration": 4887872836,
  "created_at": "2024-03-12T05:03:17Z",
  "reported_at": "2024-03-12T05:03:16Z"
}

Apendix

System Down

if the system run in to a problem, the system status will return false and message “vendor is down”

Suggest

you can create a routing system, if the message is “vendor is down”and status is false, you can create failover system to other gateway or to other otp vendor you have.

Webhook

you can add a web hook for faster alert, this web hook will notify your system if one or some of our services is not healthy.

https://webhook.site/#!/59e91100-1ed5-4e97-8da3-bd663d33c5b2/af3154ef-0b50-44c0-b002-1ed0d5965e57/1

Status

"status": "healthy"
for services that run without any problem

"status": "unhealthy"
for services that run with problem or down

POST
[
  {
    "vendor": "CitCall",
    "data": [
      {
        "product": "MOTP",
        "status": "unhealthy"
      },
      {
        "product": "SMSOTP",
        "status": "healthy"
      },
      {
        "product": "SMS BLASTING",
        "status": "healthy"
      }
    ]
  },
  {
    "vendor": "Damcorp",
    "data": [
      {
        "product": "WhatsApp",
        "status": "healthy"
      }
    ]
  },
  {
    "vendor": "Gupshup",
    "data": [
      {
        "product": "WhatsApp",
        "status": "healthy"
      }
    ]
  },
  {
    "vendor": "IMS",
    "data": [
      {
        "product": "SMSOTP",
        "status": "healthy"
      },
      {
        "product": "SMS BLASTING",
        "status": "healthy"
      }
    ]
  },
  {
    "vendor": "Kata.ai",
    "data": [
      {
        "product": "WhatsApp",
        "status": "healthy"
      }
    ]
  },
  {
    "vendor": "King One",
    "data": [
      {
        "product": "WhatsApp Long Number",
        "status": "healthy"
      },
      {
        "product": "WhatsApp BLASTING",
        "status": "healthy"
      }
    ]
  },
  {
    "vendor": "Mailgun",
    "data": [
      {
        "product": "Email",
        "status": "healthy"
      },
      {
        "product": "Email BLASTING",
        "status": "healthy"
      }
    ]
  },
  {
    "vendor": "TapTalk",
    "data": [
      {
        "product": "WhatsApp Long Number",
        "status": "healthy"
      },
      {
        "product": "WhatsApp BLASTING",
        "status": "healthy"
      }
    ]
  }
]