Introduction
The Mislaka-API allows you to send transactions call to Swiftness through a simple REST API.
'Nobel Digital' Is Authorized Distributor Of Swiftness.
Email: [email protected]
Website: https://www.nobel.co.il
Api Version: 1.0.0
Registeration
Swiftness services can be access by applying the following steps:
- Active Insurance License
- Registerd at Swiftness LTD.
- Apply premission-form signed by us & you to Swiftness LTD
- C.Card for purchase Subscription plan
Pricing
Subscription plan
- Monthly fee - 320 ILS
- 3.5 ILS per request and handling
- Installation / Connect to CRM / Automation / Custom service - Lets Talk
Authentication
In order to use the API, you should authenticate your request by including your API key as token value:
Authorization: token API_KEY_HERE
Api token key generate after your account will be verified
If needed you can change your API key throw settings page
Headers
Make sure you have the following content type headers are on every request:
Accept: application/json
Content-Type: application/json
URI
Mislakas's API is hosted on the following base URI:
https://mislaka-api.co.il/api
Errors
Mislaka uses conventional HTTP response codes to indicate the success or failure of an API request. The table below contains a summary of the typical response codes:
Code | Description |
---|---|
200 | Everything is ok. |
400 | Valid data was given but the request has failed. |
401 | No valid API Key was given. |
404 | The request resource could not be found. |
422 | The payload has missing required parameters or invalid data was given. |
429 | Too many attempts. |
500 | Request failed due to an internal error in Mislaka. |
503 | Mislaka is offline for maintenance. |
Rate Limit
This Limitation is to prevent overloading of our servers and anti flood attack,
We apply limit of 100 requests per min
API History
Inside the dashboard you will have logs for each API request
You can trace the following data:
- Datetime
- Method
- Endpoint
- Payload
- Sender Ip
- Transaction Id
- Leads Pages
Get All Pages
GET /api/leads-pages
Response
{[
"page_name": "",
"status": "Active / Inactive",
"forms": ["נספח א","הר הביטוח","פוליסות מחברות הביטוח"],
"send_9100": true,
"redirect_url": "",
"webhook_url": "",
]}
Get Records List
Response
{[
"first_name": "",
"last_name": "",
"id_number": "",
"email": "",
"mobile_phone": "",
"ip_address": "",
"user_agent": "",
"forms": ["form_a_id":"","form_harb_id":"","form_insurance_polisot":""],
"page_url": "",
"status": "Active / Inactive",
"params": "",
"transaction_id": "",
"send_9100": "",
"redirect_url": "",
"webhook_url": "",
"webhook_response_code": 200,
"webhook_response_content": "",
]}
HTTP Request
GET /api/leads-pages/records
- Mislaka Forms
Send 'Form A' To Client
Payload
{
"sender_id":"",
"type":"A",
"first_name": "",
"last_name": "",
"person_id_number": "",
"city_name":"",
"address": "",
"house_number": "",
"mobile":"",
"email":"",
"send_type": "email",
"send_9100_when_signed": true
}
Response
{
"message":"Form sent to client",
"formId":"xxxx-xxxx-xxxx-xxxx",
}
HTTP Request
POST /api/forms
Request Stracture
Key | Type | Required | Description |
---|---|---|---|
sender_id |
String | Yes | Id number of the sender |
type |
String | Yes | "A" |
first_name |
String | Yes | Firstname of client |
last_name |
String | Yes | Lastname of client |
person_id_number |
String | Yes | Id number - 9 digits |
city_name |
String | Yes | City of client |
address |
String | Yes | Street of client |
house_number |
String | No | House number of client |
mobile |
String | Yes - if target is mobile | Mobile number In case we want to send by SMS |
email |
String | Yes - if target is email | Email address In case we want to send by Email |
send_type |
email/sms/email_sms | Yes | By what method to send the client (Email/Sms/Both) |
send_9100_when_signed |
Boolean | Yes | if to send 9100 request automatically when the form is signed |
Get Form
Response
{
"form_id": "",
"person_id_number": "",
"client_first_name": "",
"client_last_name": "",
"client_email": "",
"client_phone": "",
"client_ip": "",
"client_browser": "",
"client_platform": "",
"signed_date": "",
"sent_by": "SMS",
"status": "Signed",
"created": "2024-02-02T14:28:51.000000Z",
"updated": "2024-02-02T16:39:34.000000Z",
"9100_created": true,
"transaction_id": "xxxx-xxxx-xxxx-xxxx",
"mislaka_number": "xxxx-xxxx-xxxx-xxxx",
}
HTTP Request
GET /api/forms/{formId}
Get File
Response
return the file content for downloading (PDF)
HTTP Request
GET /forms/{formId}/files/
Del Files
Response
{
"message":"FormA File deleted successfully",
"formId":"xxxx-xxxx-xxxx-xxxx",
}
HTTP Request
DEL /forms/{formId}/files/
* Note: this method will Delete also `9100 Transaction` Files if exsist
- Mislaka Transactions
Create Transaction (9100 - Information request)
Payload
{
"type":"9100",
"first_name": "",
"last_name": "",
"person_id_number": "",
"signed_date": "31/12/2023",
"city_name":"",
"address": "",
"house_number": "",
"sender_id" : "",
}
Response
{
"message":"File was Sent To Mislaka",
"transactionId":"xxxx-xxxx-xxxx-xxxx",
}
HTTP Request
POST /api/transaction
Acceptable Types
Key | Value |
---|---|
type |
9100 |
type |
1700 |
type |
productions (comming soon) |
Required Scopes
This endpoint requires the transaction:create
scope.
Create Transaction (1700 - Power of Attorney)
Payload
{
"type":"1700",
"first_name": "",
"last_name": "",
"person_id_number": "",
"signed_date": "31/12/2023",
"city_name":"",
"address": "",
"house_number": "",
"power_of_attorney_file_url":"http://...",
"identification_file_url":"http://..."
}
Response
{
"message":"File was Sent To Mislaka",
"transactionId":"xxxx-xxxx-xxxx-xxxx",
}
HTTP Request
POST /api/transaction
Acceptable Types
Key | Value |
---|---|
type |
9100 |
type |
1700 |
type |
productions (comming soon) |
Acceptable Files
Key | Value |
---|---|
power_of_attorney_file_url |
Link To Image / PDF File |
identification_file_url |
Link To Image / PDF File |
Get Transaction
Response
{
"transaction_id":"xxxx-xxxx-xxxx-xxxx",
"mislaka_number":"xxxx-xxxx-xxxx-xxxx",
"status":"finished",
"action_code":"9100",
"person_id_number":"123456789",
"amount_of_responses":"86",
"created":"",
"updated":""
}
HTTP Request
GET /api/transaction/{transactionId}
Get File
Response
return the file content for downloading
HTTP Request
GET /transaction/{transactionId}/files/{fileType}
Acceptable Types
Key | Value |
---|---|
fileType |
|
fileType |
XLS |
fileType |
ZIP |
Del Files
Response
{
"message":"Files deleted successfully",
"transactionId":"xxxx-xxxx-xxxx-xxxx",
}
HTTP Request
DEL /transaction/{transactionId}/files/
* Note: this method will Delete also `Form A` File if exsist
Masked Record
Response
{
"message":"Record Masked successfully",
"transactionId":"xxxx-xxxx-xxxx-xxxx",
}
Example Of Masked Data
Key | Value |
---|---|
Name |
יה**** כ** |
id Number |
******730 |
HTTP Request
GET /api/transaction/{transactionId}/masked
- Polisot
Get Polisot List Of Transaction
GET /api/transaction/{transactionId}/polisot/
Request Stracture
Key | Required | Description |
---|---|---|
transactionId |
Yes | Transaction Id in url |
Response
{ "transaction_id":"xxxx-xxxx-xxxx-xxxx",
"mislaka_number":"xxxx-xxxx-xxxx-xxxx",
"status":"finished",
"action_code":"9100",
"person_id_number":"123456789",
"polisot":[
{
"manufacturer": "",
"product_type": "",
"polisa_number" : "xxxxxx",
"polisa_name" : "xxxxxx",
"polisa_status" : "active",
}
]}
All Polisot Data
Response
{ "transaction_id":"xxxx-xxxx-xxxx-xxxx",
"mislaka_number":"xxxx-xxxx-xxxx-xxxx",
"status":"finished",
"action_code":"9100",
"person_id_number":"123456789",
"polisot":[
{
*** Full Data Of Polisa **
}
]}
HTTP Request
GET /api/transaction/{transactionId}/polisot/data
Request Stracture
Key | Required | Description |
---|---|---|
transactionId |
Yes | Transaction Id in url |
Get Data Of Specific Polica
Response
{ "transaction_id":"xxxx-xxxx-xxxx-xxxx",
"mislaka_number":"xxxx-xxxx-xxxx-xxxx",
"status":"finished",
"action_code":"9100",
"person_id_number":"123456789",
"polisot":[
{
*** Full Data Of Polisa **
}
]}
HTTP Request
GET /api/transaction/{transactionId}/polisot/{polisa_Number}
Request Stracture
Key | Required | Description |
---|---|---|
transactionId |
Yes | Transaction Id in url |
polisa_Number |
Yes | Polisa Number in url |
Webhooks
When transaction is finished You can get callback with files to speisifc webhook url.
A general webhook can be sent for 9100 or 1700 requests.
Webhook response
{
"transaction_id":"xxxx-xxxx-xxxx-xxxx",
"mislaka_number":"xxxx-xxxx-xxxx-xxxx",
"status":"finished",
"action_code":"9100",
"person_id_number":"123456789"
}
Security
Security And Your Data Is Important For Us.
Guildlines Points
- Data is stored only for 7 days!
All files that exsists 7 days >= will be deleted.
Within this process: after files deleted,
We Masking(*) in our DB all PII information like - Person ID number & Person name - Masking & Delete files methods is available now throw API
Strongly suggestion after feach files - send request to Delete files & Mask Data.
Login
- Login Required 2FA to your mobile phone
- Make sure to change Password Once in 3-6 months
- Few bads login attempts will block your login
Api
- Send your API Request with TLS 1.2 or higher
- Only HTTPS - Regular Http is blocked
- Rate Limit - 100req/1min
- Ips Restriction - you can setup Ips WhiteList to receive requests
Automation Platforms
Our goal is to make it easier for you.
Platform | Status | Link |
---|---|---|
Connectika.io |
✅ Done | Link |
Zapier |
⏳ Comming Soon | |
Make |
⏳ Comming Soon |
Postman Collection
Using Postman ? Contact US and we will send you
Collection.json file that contains all our api requests.
Contact With Us
Have questions?
Email: [email protected] | Phone: 058-408-4080