Message Rest API QuickStart

Set up Message Rest API

Before using Rest API, you need to complete the following setup steps.

Step 1: Create a service account

To create a service account, follow these steps.

1. On the left navigation pane, click Service Accounts.

2. Click Create Service Account.

3. (Optional) Select Super Admin to grant the service account with Super admin access to a namespace or tenant.

4. Enter a name for the service account, and then click Confirm.

Step 2: Create an API key of your service account

You can follow the instructions to create an API key for the service account you choose to use.

Step 3: Grant service account permissions

1. On the left navigation pane, in the Admin section, click Tenants/Namespaces.

2. Select the Public tenant, then select the Default namespace under the tenant.

3. Select the POLICY tab.

4. In the Authorization area, click ADD ROLE, and select the name of the service account you just created in the previous section.

5. In the Authorization area, on the drop-down menu below the service name you just added, select the consume and produce roles. The roles are added to your service account.

Step 4: Get the HTTP Service URL of your StreamNative cluster

To get the service URL(s) of a StreamNative cluster, follow these steps.

Work with Message Rest API

After you have completed the configuration steps above, you can use Rest API to produce and consume messages. Rest API sends binary data. You can use the cURL tool to encode a string (for example Hi Pulsar) into UTF-8 format bytes. To send bytes in another format, you need to specify an appropriate file. For more information, see the cURL documentation.

1. Create a subscription on the topic.

   curl -X PUT https://<endpoint>:<port>/admin/v2/persistent/public/default/rest-topic/subscription/rest-sub \
     --header 'Authorization: Bearer <API Key>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json'
   

   You should see the following output:

   # No content response
   

2. Produce messages to the topic.

   curl -X POST https://<endpoint>:<port>/admin/rest/topics/v1/persistent/public/default/rest-topic/message \
     --header 'Authorization: Bearer <API Key>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/octet-stream' \
     --data-binary 'Hi, Pulsar'
   

   You should see the following output:

   # Message id in string format
   10:0:-1:0
   

3. Consume messages from the topic.

   curl -X POST https://<endpoint>:<port>/admin/rest/topics/v1/persistent/public/default/rest-topic/rest-sub/message \
     --header 'Authorization: Bearer <API Key>' \
     --header 'Accept: application/octet-stream' \
     --header 'Content-Type: application/json' -v
   

   You should see the following output:

   # Headers
   X-Pulsar-Message-Id: CAoQACAAMAE=
   X-Pulsar-Message-String-Id: 10:0:-1:0
   X-Pulsar-Sequence-Id: 0
   
   # Body
   Hi, Pulsar
   

4. Acknowledge messages.

   curl -X PUT https://<endpoint>:<port>/admin/rest/topics/v1/persistent/public/default/rest-topic/rest-sub/message \
     --header 'Authorization: Bearer <API Key>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data-raw 'CAoQACAAMAE='
   

   You should see the following output:

   # No content response
   

5. Negative acknowledge messages.

   curl -X PUT https://<endpoint>:<port>/admin/rest/topics/v2/persistent/public/default/rest-topic/rest-sub/message \
     --header 'Authorization: Bearer <API Key>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data-raw '{"encodedMessageId":"CAoQACAAMAE=","negativeAck":"true"}'
   

   You should see the following output:

   # No content response
   

Message Rest API reference

For further information, see Message Rest API reference.