Getting started with the API

This topic helps your technical team choose an API type, create credentials, try sending a message, and receive delivery statuses through a webhook. The endpoint details are in the reference topics linked in each section.

Who can use these menus

All pages in this topic are for Admins only. Each page also appears only after the platform operator has activated the related API feature for your business.

Choose an API type

For a new integration, choose Business API v1.

Create Business API v1 credentials

1. Open Developers > API Access.
2. Click the create button in the top right.
3. Enter a Name, for example Integrasi Toko Sumber Rejeki.
4. Fill in Allowed IPs if you want to limit the server IP addresses that can use these credentials. If it is empty, all IP addresses are accepted.
5. Click Create.
6. Copy the Public Key and the Secret Key that appear, then store them on your integration server as <PUBLIC_KEY> and <SECRET_KEY>.

Note the following:

• The Secret Key is shown only once. The application stores it as a hash, so it cannot show it again.
• If you lose the Secret Key, regenerate the secret. Integrations that still use the old secret stop working right away.
• Requests from IP addresses outside the list are rejected with the code ip_not_allowed.

Create H2H, CGW, or CST ACS credentials

Create H2H and CGW credentials in Developers > H2H CGW API Setup. Select the Protocol that matches the format of your existing integration, then fill in the data that the form asks for, including the status webhook URL if your integration receives status reports.

Create CST ACS credentials in Developers > API CST. Select the WhatsApp channel used for sending, then fill in the Status webhook URL if you want to receive status reports.

Both pages also have an Allowed IPs field. How to use each credential is explained in H2H & CGW API and API CST ACS.

Try sending a message in API Playground

On the Help > API Playground page, you can send a test message with your own credentials, then see the request, the response, and the delivery status.

1. Open Help > API Playground.
2. Select an API type. Only API types whose feature is active appear. H2H and CGW appear only if your business already has active credentials for that protocol.
3. Fill in the message data, then send it.
4. Check the request, the response, and the delivery status that appear.

This page also shows code examples built from your input, including an example webhook receiver for your server. Credentials appear as placeholders, unless you select Show real credentials.

Note that a test message is a real message that is actually sent to the destination number.

Receive delivery statuses through a webhook

For Business API v1, message delivery statuses (for example delivered, read, or undelivered) are sent to your webhook URL.

1. Open Developers > Webhooks.
2. Click Add Webhook, or New Business webhook if webhooks already exist.
3. Enter the Webhook URL, for example https://api.tokosumberrejeki.co.id/webhook/status.
4. Make sure Active is on, then click Create.

Each status carries a messageid that is the same as the message ID in the send response. Store that ID so that you can match the status to your message. The webhook body format is explained in API, Testing & Error Codes.

For H2H, CGW, and CST ACS, the status webhook is set in the form of each credential, not in the Webhooks menu.

Also, the Webhook topic explains the webhooks that the application receives from WhatsApp, Telegram, Instagram, and payments. That topic is not about the status webhook for your messages.

Request limits

H2H, CGW, and CST ACS are limited to 600 requests per minute for each credential. Requests over the limit are rejected, and you can try them again in the next minute.