0% found this document useful (0 votes)
142 views

API Mepro Data Package - v1.4

This document outlines the MePro API Data Package, including endpoints and parameters for: 1. Getting balance status 2. Checking gift request status 3. Creating a gift request 4. Subscribing to information 5. Whitelisting packages It provides details on resource specifications, request and response headers/bodies for each endpoint.

Uploaded by

Ahsan Shafique
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
142 views

API Mepro Data Package - v1.4

This document outlines the MePro API Data Package, including endpoints and parameters for: 1. Getting balance status 2. Checking gift request status 3. Creating a gift request 4. Subscribing to information 5. Whitelisting packages It provides details on resource specifications, request and response headers/bodies for each endpoint.

Uploaded by

Ahsan Shafique
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 12

Interface Agreement

MePro API Data Package

Internal
Document History

Revision History
Date Name Version Summary of
Changes
24/08/2021 Salmun Andoni 1.1 Add POST Whitelist Package & Get Gift Request Status Rules
10/03/2022 Salmun Andoni 1.2 Update Rules Subscription Info & Callback Gift Request Create
30/06/2022 Salmun Andoni 1.3 Update Callback Parameter
22/11/2022 Salmun Andoni 1.4 Update Information Protocol TLS 1.2

Internal

1
Contents
MePro API Data Package ................................................................................................................ 2
Document History ....................................................................................................................... 1
Revision History...................................................................................................................... 1
1. Get Balance Status ............................................................................................................... 3
2. Get Gift Request Status ........................................................................................................ 5
3. Post Create Gift Request ...................................................................................................... 7
4. POST Subscription Information ........................................................................................... 9
5. POST Whitelist Package .................................................................................................... 10
6. Appendix ............................................................................................................................ 11
1. Get Balance Status
This service is intended to get balance information, usage and credit usage limits for the services you
subscribed

1.1. Resource Spesification


Description API MePro Check Balance Status
Production Endpoint URI https://api.digitalcore.telkomsel.com/scrt/v2/b2b/balance

Transport Protocol HTTPS


Request Verb GET
Content Type application/json
Interaction Type Synchronous
Security Policy*
Protocol TLS 1.2

1.2. Request & Response


1.2.1. Request Headers

Header Field Name Acceptable Value


api_key api key for customer
x-signature for generate x-signature please refer to appendix how to create x-signature

api_key:qkz8q8axgf7jbhub7mw7xxxx
x-signature:75600c651e91d3c00a38f1b0c666xxxx

1.2.2. Request Parameter

Element Name Data Type M/O Description


A unique key for subscription,
subscriptionKey String (255) M informed to partner client.
E.g. PM9DZ8DGEXA80VYIAUF1
Note: M=Mandatory, O=Optional

Request Example:

https://api.digitalcore.telkomsel.com/scrt/v2/b2b/balance?subscriptionKey=SN1MG6IYOZVQ
YK0ICNUE

1.2.3. Response Header

Header Field Name Acceptable Value


Content-Type application/json

Request Headers Example:


Content-Type: application/json

Internal

3
1.2.4. Response Body

Element Name Data Type M/O Description

subscriptionKey String M A unique key for subscription, informed to


(255) partner client.
unit String M Unit of measurement for quota.
(255) E.g: mb
The remaining balance of this subscription.
balance String M
E.g: 100000
(255)
usage String M Usage of the subscription (must be balance)
(255)
limitUsage String M Limit Usage balance
(255)
Note: M=Mandatory, O=Optional

Response Body Success Example HTTP-200 :

{
"subscriptionKey": "SN1MG6IYOZVQYK0ICNUE",
"unit": "mb",
"balance": 6497000,
"usage": 3000,
"limitUsage": 6500000
}
2. Get Gift Request Status
This service is intended to check your gift package and service that is running, scheduled or has been
successfully done by the system. You can get information about your gift transaction.

Notes : Use this API Check Status If within 3 minutes does not received callback status

2.1. Resource Spesification


Description API MePro Gift Request Status
Production Endpoint URI https://api.digitalcore.telkomsel.com/scrt/v2/b2b /gift-request-status

Transport Protocol HTTPS


Request Verb GET
Content Type application/json
Interaction Type Synchronous
Security Policy*
Protocol TLS 1.2

2.2. Request & Response


2.2.1. Request Headers

Header Field Name Acceptable Value


api_key api key for customer
x-signature for generate x-signature please refer to appendix how to create x-signature

Request Headers Example:

api_key:qkz8q8axgf7jbhub7mw7xxxx
x-signature:75600c651e91d3c00a38f1b0c666xxxx

2.2.2. Request Parameter

Element Name Data Type M/O Description

requestId String (255) M Gift data request id

subscriptionKey String M A unique key for subscription,


(255) informed to partner client.

Note: M=Mandatory, O=Optional

Request Example:

https://api.digitalcore.telkomsel.com/scrt/v2/gift-
request/status?requestId=GUI3038120210504070230QCS&subscriptionKey=SN1MG6IYOZVQYK0
ICNUE

Internal

5
2.2.3. Response Header

Header Field Name Acceptable Value


Content-Type application/json

Request Headers Example:

Content-Type: application/json; charset=UTF-8


api_key:
x-signature:

2.2.4. Response Body

Element Name Data Type M/O Description


subscriptionKey String M A unique key for subscription, informed to
(255) partner client.

requestId String M Unique id generated by system for transaction


(255)

Status of transaction
Status String M
(255)

Note: M=Mandatory, O=Optional

Response Body Success Example HTTP-200 :

{
"subscriptionKey": "TW3IUDBNQR8KXNQFB7WQ",
"requestId": "GUI3038120210504070230QCS",
"status": "success"
}

Response Body Failed Example HTTP-200 :

{
"subscriptionKey": "TW3IUDBNQR8KXNQFB7WQ",
"requestId": "GUI3038120210504070230QCS",
"status": "failed"
}
3. Post Create Gift Request
This service is intended to edit your scheduled gift request, please do not enter your execution time with
elapsed time. Since status gift requests are still idle, you can change your best execution plan.

3.1. Resource Spesification


Description Post Gift Request
Production Endpoint URI https://api.digitalcore.telkomsel.com/scrt/v2/b2b/gift-request-create

Transport Protocol HTTPS


Request Verb POST
Content Type application/json
Interaction Type Synchronous
Security Policy*
Protocol TLS 1.2

3.2. Request & Response


3.2.1. Request Headers

Header Field Name Acceptable Value


api_key api key for customer
x-signature for generate x-signature please refer to appendix how to create x-signature

Request Headers Example:

api_key:qkz8q8axgf7jbhub7mw7xxxx
x-signature:75600c651e91d3c00a38f1b0c666xxxx

3.2.2. Request Parameter


(No Request Paramater)
3.2.3. Request Body

Element Name Data Type M/O Description


paket String M Package name of the gift
(255)

msisdn String M Mobile Subscriber Integrated


(255) Services Digital Network Number

subscriptionKey String M A unique key for subscription,


(255) informed to partner client.

callbackurl String M Domain and path for receiving status


(255) gift from Mepro.
Notes : Client connection must have
SSL installed, with HTTPS.
Parameter will send data request_id
and status. Using method : GET
Note: M=Mandatory, O=Optional

Notes: callbackurl will be sent from Mepro with following rules,

Format : [callbackurl]?[request_id=GUIxxxxx]&[status=success]
Example: https://id.i-
chat.id/callback.php?request_id=GUI3652020220310010657ZZZ&status=success
Internal

7
Request Example:

paket:Combo 1GB
msisdn:6281394030381
subscriptionKey:M1XX3PHGOOC0M5528LIR
callbackurl:https://id.i-chat.id/callback.php

3.2.4. Response Header

Header Field Name Acceptable Value


Content-Type application/json

Request Headers Example:


Content-Type: application/json

3.2.5. Response Body

Element Name Data Type M/O Description


success String (255) M Indicator result of transaction

id String (255) M Auto generated id

name String M Package name of the gift


(255)

requestId String M Unique id generated by system for transaction


(255)

Note: M=Mandatory, O=Optional

Response Body Success Example HTTP-200 :

{
"success": true,
"id": "599",
"name": "denom-flash-corp-b2b2c-100mb",
"requestId": "GUI0744620210622002046MUX"
}

Response Body Failed Example HTTP-200 :

{
"success": false,
"msg": "subscriptionKey not found"
}

Request callbackurl With Transaction Success Example HTTP-200 :

https:// id.i-chat.id/callback.php?request_id=GUI3652020220310010657ZZZ&status=success
4. POST Subscription Information
This service is used to view information about the subscriptionKey and servicePackageName belonging to
a pilot number.

Notes: Please ask your Account Manager for subscriptionKey that can be used

Internal

9
5. POST Whitelist Package
This service is used to view information about the servicePackageName and Denom (Product Keyword)

5.1. Resource Spesification


Description Post Whitelist-Package
Production Endpoint URI https://api.digitalcore.telkomsel.com/scrt/v2/b2b/whitelist-package

Transport Protocol HTTPS


Request Verb POST
Interaction Type Synchronous
Security Policy*
Protocol TLS 1.2

5.2. Request & Response


5.2.1. Request Headers

Header Field Name Acceptable Value


api_key api key for customer
x-signature for generate x-signature please refer to appendix how to create x-signature

Request Headers Example:

api_key:qkz8q8axgf7jbhub7mw7xxxx
x-signature:75600c651e91d3c00a38f1b0c666xxxx

5.2.2. Request Parameter


(No Request Paramater)
5.2.3. Request Body

Element Name Data Type M/O Descriptio


n
subscriptionKey String M the subscriptionKey that has
(255) been given the Service Package
Name
Note: M=Mandatory, O=Optional

Request http-post Example:

subscriptionKey:BW7WLIOL6BT3THLXLG2S

5.2.4. Response Header

Header Field Name Acceptable Value


Content-Type application/json

Request Headers Example:


Content-Type: application/json
5.2.5. Response Body
Response Body Success Example HTTP-200 :

{
"success": true,
"data": [
{
"subscriptionKey": "9QM6M4HRIY7SOZYVT85N1",
"serviceName": "DATA",
"servicePackageName": "Paket Renewal Kuota 25TB 3 Bulan",
"pilotNumber": "628111166255",
"denom": [
"denom-flash-corp-b2b2c-100mb"
]
}
]
}

Response Body Failed Example HTTP-200 :

{
"success": false,
"message": "no record's found"
}

6. Appendix
6.1. How To Get Signature Key

Create script below with input your api key and your api secret
<?php

$api_key = 'your_api_key';
$secret = 'your_api_secret';
$timestamp = gmdate('U');
$sig = md5($api_key . $secret . $timestamp);

echo "signatureKey: $sig";

?>

Internal

11

You might also like