[#1245] book function client id, invoice creation, and payment webhook

API General
,
1

Migrated from Redmine #1245 | Author: Gym Master
Status: Feedback | Priority: High, I’m very impatient | Created: 2024-06-21

Hi, I have 2 questions regarding the API:

  1. I want to use book function from public service. Is it possible to pass client id so that it doesn’t create a new client everytime? OR, if I can only use the book function from admin service to pass the client id, is it possible to make it not auto confirmed so then I can proceed to create/get invoice and let the user pay the the invoice first.

  2. I want to use getBookingCart to let the user to book for multiple booking. AFAIK, if I use getBookingDetails(bookingId, sign) of a booking, I get the invoice_id and continue to payment flow. Is it possible to get invoice_id from a cart? how? if it isn’t possible, should I create invoice in my system myself and process the payment myself (without using SBPay)? or there’s another way to keep using SBPay?

  3. Is it possible to get SBPay checkout URL from API? Or is it okay if I redirect the user to this url? `https://gymblaze.simplybook.asia/v2/ext/invoice-payment/pay/system/xendit/invoice_id/${invoice_id}

  4. Is it okay if I intercept the webhook from Payment Service Provider (xendit) to my server first before I forward the webhook content to SBPay?

2

Gym Master wrote:

Hi, I have some questions regarding the API:

  1. I want to use book function from public service. Is it possible to pass client id so that it doesn’t create a new client everytime? OR, if I can only use the book function from admin service to pass the client id, is it possible to make it not auto confirmed so then I can proceed to create/get invoice and let the user pay the the invoice first.

  2. I want to use getBookingCart to let the user to book for multiple booking. AFAIK, if I use getBookingDetails(bookingId, sign) of a booking, I get the invoice_id and continue to payment flow. Is it possible to get invoice_id from a cart? how? if it isn’t possible, should I create invoice in my system myself and process the payment myself (without using SBPay)? or there’s another way to keep using SBPay?

  3. Is it possible to get SBPay checkout URL from API? Or is it okay if I redirect the user to this url? `https://gymblaze.simplybook.asia/v2/ext/invoice-payment/pay/system/xendit/invoice_id/${invoice_id}

  4. Is it okay if I intercept the webhook from Payment Service Provider (xendit) to my server first before I forward the webhook content to SBPay?

3

Gym Master wrote:

One more question, how to pass product ids to the public service book function? Or I can only use the REST API?

4

Gym Master wrote:

Another question: The getClientBookings($clientId, $sign, $filter) function, need sign param, in the documentation, the sign param is generated using md5(bookingId, bookingHash, secretKey), this is weird, how can I know the booking id and hash while I don’t have the booking list yet?

5

Dmytro Bondarev wrote:

Hi,

  1. yes you can. In $clientData you can pass client_id and client_sign , where client_sign is md5(clientId + clientHash + secretKey).
    clientHash you can receive after first booking or when you create client, get client info, etc.

  2. Unfortunately this method is deprecated. Please pass handle_invoice: true in $additional and you will receive invoice object if payment is required.

  3. It is not possible at the moment.

  4. Yes it is ok.

One more question, how to pass product ids to the public service book function?
You can pass it in $additional parameter as products: [{id: 1, qty: 1}, …]

Another question: The getClientBookings($clientId, $sign, $filter) function, need sign param, in the documentation, the sign param is generated using md5(bookingId, bookingHash, secretKey), this is weird, how can I know the booking id and hash while I don’t have the booking list yet?
this is client signature the same as above.

6

Gym Master wrote:

  1. So, you said that getBookingCart is deprecated, but I still can use it by passing handle_invoice param. Is there any plan to remove getBookingCart? What is the replacement of this function that’s more future proof? What’s the difference between cart vs batch?
7

Dmytro Bondarev wrote:

Hi, yes it is deprecated.
If you provide handle_invoice you will receive order in response with details.

8

Gym Master wrote:

Hi, I tried to call the public service book function with additional value client_id and client_sign, but I got error “-32061 Client name value is wrong”. I tried providing the name, email, and phone, but it still creating a new client. Is there anything I missed?

Example request:


book(
    2,
    5,
    "2024-06-24",
    "16:30:00",
    {
      client_id: "18",
      client_sign: simplybook.sign("18", "4799743cde1218a5f992322ea0dcbba1"),
    },
    [
      {
        field: "handle_invoice",
        value: true,
      },
      {
        field: "products",
        value: { id: 1, qty: 1 },
      },
    ],
  )
9

Gym Master wrote:

Hi, sorry, I need to follow up this thread, it’s been one week, can you help answer the question above?

10

Dmytro Bondarev wrote:

Hi, sorry for late answer.
You should pass it in following way:


book(
    2,
    5,
    "2024-06-24",
    "16:30:00",
    {
      client_id: "18",
      client_sign: simplybook.sign("18", "4799743cde1218a5f992322ea0dcbba1"),
    },
    {
      "products": [{"id": 1, "qty": 1}],
      "handle_invoice": true
    }
  )
11

Gym Master wrote:

I think the issue is not on the attribute field, the error is on client email field.

12

Gym Master wrote:

I already tried your attribute structure

This is the response:

{"error":{"name":"RpcError","code":-32061,"data":{"field":"name"}},"timestamp":"2024-07-01T16:06:39.072Z"}
13

Dmytro Bondarev wrote:

Hi, sorry for delay.
If you don’t have Client login enabled, then you still have to pass name, email, phone for the client.