Introduction

This documentation aims to provide all the information you need to work with our API.

About API endpoint URL

The endpoint URL is https://api.icafecloud.com

API Wiki

Getting Started

The following instructions explain how to generate and use the API

1. When switching the iCafeCloud license between master and slave servers (EU3 to EU4), there is no need to update the API, as it remains unchanged. However, if you switch to a different server group ( EU3 to EU18), the API key must be recreated.
2. Log in to the Admin panel using the "Admin" account, as only the Admin account can create APIs.
3. You must use a static IP or a VPS, as the IP will be bound to the token. To ensure optimal API usage, it is recommended to make API calls from a static IP server, such as a VPS, rather than directly from a client device.
4. You can use either IPv4 or IPv6 for the API IP.
5. To add more than one IP to the list, separate them with commas ( IP1, IP2, IP3).
6. To assist users in identifying their exact IP address during troubleshooting, the system will now include the user's IP address directly in error message

   {"code": 401, "message'": "Unauthorization from YOUR_IP"}

7. From the "Settings" page of the Cloud Panel, add the IP you selected as your server IP under "API Access IP." Then, generate your API key by clicking the "Create" button.
8. Note that the API key is valid for one year.
9. The API address is fixed as api.icafecloud.com
10. Once you create a new API key, the old API key will become invalid. We only support one API key at a time.
11. Click the "Copy" button and save your api key. It's only shown once.
12. API docs https://dev.icafecloud.com/docs/
13. You need to add a http header with the "Authorization: Bearer api_key" to authenticate the API access.
14. To add parameters on the API use Body and not Headers.[On postman can use Body , Form-data and add parameters.
15. The API endpoint URL should always use HTTPS not HTTP.
16. You can try the API directly on the iCafeCloud dev.icafecloud.com. Follow these steps:
    • Click the link to https://dev.icafecloud.com/docs/#boot-pcs-apis
    • Fill in the Bearer token and CafeID, which you can find in your iCafeCloud license.
    • Click "Send Request" to retrieve data from the PCs.
    • This process allows you to interact with and test the API functionalities effectively.
17. Notify balance changes to client PC. Once you've initiated the top-up API call, the next step would be to call the pushClientstatus API. This step is crucial as it ensures that the client's PC is notified of the update
18. For the API to auto add bonus on topup use:
    • To get the bonus = POST api/v2/cafe/{cafeId}/members/action/fetchBonus
    • And use it as parameter at = POST api/v2/cafe/{cafeId}/members/action/topup -> topup_balance_bonus

Get parameters format in API

Last Updated: Apr 26, 2024

This is how to find API parameters using the console.

1. To identify the parameters for the APIs, open the Chrome console and navigate to the Network tab. Perform an action from the iCafeCloud panel, and you will find the parameters in the Network tab. For example: you can purchase an offer as a member. In the console, you will be able to locate the parameters being used for this action. (Figure 1)

API limitations

Last Updated: 2024-04-26

Api load ate limitation is 200 request per minute

Max limit for some operations:

• const MAX_STAFF = 100;
• const MAX_MEMBERGROUP = 100;
• const MAX_MEMBER = 50000;
• const MAX_NEWS = 100;
• const MAX_PRICE = 100;
• const MAX_PRODUCTGROUP = 100;
• const MAX_PRODUCT = 500;
• const MAX_OFFER = 1000;
• const MAX_PCGROUP = 100;
• const MAX_PC = 500;
• const MAX_ROOM = 100;
• const MAX_PAUSE = 100;
• const MAX_BOOTPC = 500;
• const MAX_HARDWARE = 100;
• const MAX_GAMECLASS = 100;
• const MAX_GAME = 1000;
• const MAX_POOL = 100;
• const MAX_POOLLICENSE = 100;
• const MAX_EVENT = 100;
• const MAX_IDCCONFIG = 100;
• const MAX_IDCCLASS = 100;
• const MAX_ORDER = 5000;

Get member id by member account via API

Last Updated: Oct 11, 2024

Retrieve a member ID using a member account via the API

1. To retrieve the member ID using member accounts via the API, refer to the API in the link below.(Figure 1)
   https://dev.icafecloud.com/docs/#members-apis-POSTapi-v2-cafe--cafeId--members-action-memberInfo

Get CCBoot Client status via API

Last Updated: Oct 11, 2024

How to get ccboot client status by api

1. Get CCBoot client status by wss command front he link below
   https://dev.icafecloud.com/docs/#pc-sessions-apis-POSTapi-v2-cafe--cafeId--pcSessions-sendWssCommand
2. For command use “pc_status”

   {"action":"pcs_status","target":"boot","type":"request","from":"web","version":2,"data":[]}

Remote reboot CCBoot Client via API

Last Updated: Oct 11, 2024

How to reboot ccboot client by api

1. To send a reboot command to a client PC via the API, find the appropriate API in the link below.
   https://dev.icafecloud.com/docs/#pc-sessions-apis-POSTapi-v2-cafe--cafeId--pcSessions-sendWssCommand
2. For command use “power” (Figure 1)
3. We support 3 different commands as "reboot", "shutdown", "poweron"

   {"action":"power", "target":"boot","data":{"power_type":"reboot","ids":[24]}}

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Settings -> API settings -> Create, Generate API token (We only support one API token).