Easily cache strings or objects with user isolation.
Caching is helpful in almost all application types.
Use this feature to store volatile values, for instance, if you’re using Stripe’s customer portal. You might want to save some state before sending your users to Stripe, and you’re able to get the value once they’re back.
Requires a root token: Store an item on the cache
HTTP request:
POST /sudo/cache
Format: JSON
Body:
| name | type | description |
|---|---|---|
| key | string |
The key for this item |
| value | object |
To object to store |
Example:
curl -H "Content-Type: application/json" \
-H "SB-PUBLIC-KEY: your-pub-key" \
-H "Authorization: Bearer root-token" \
-X POST \
-d '{"key": "test", "value": "working"}' \
https://na1.staticbackend.com/sudo/cache
const val = {a: "b", c: true};
const res = await bkn.cacheSet(rootToken, "key", val);
val := []string{"a", "b"}
if err := backend.CacheSet(rootToken, "key", val); err != nil {
//...
}
Response:
true
Requires a root token: Get an object from cache
HTTP request:
GET /sudo/cache?key=your_key
Querystring parameters:
| name | type | description |
|---|---|---|
| key | string |
The key for the item |
Example:
curl -H "Content-Type: application/json" \
-H "SB-PUBLIC-KEY: your-pub-key" \
-H "Authorization: Bearer root-token" \
https://na1.staticbackend.com/sudo/cache?key=test
const res = await bkn.cacheGet(rootToken, "key");
// res.content contains the object if found
var val []string
if err := backend.CacheGet(rootToken, "key", &val); err != nil {
//...
}
Response:
{
"a": "b",
"c": true
}
Publish a message that could trigger a server-side function.
HTTP request:
POST /publish
Format: JSON
Body:
| name | type | description |
|---|---|---|
| channel | string |
The destination channel to receive the message |
| type | string |
A custom type you may refer to in the server-side function |
| data | object |
The data for this message |
Example:
curl -H "Content-Type: application/json" \
-H "SB-PUBLIC-KEY: your-pub-key" \
-H "Authorization: Bearer user-token" \
-X POST \
-d '{"channel": "unlock-action", \
"type": "xyz-created", \
"data": {"id": "123456"}}' \
https://na1.staticbackend.com/publish
const data = {
id: "some-id-related-to-what-user-is-doing"
};
const res = await bkn.cacheGet(token,
"unlock-action",
"xyz-created",
data);
// !res.ok => failed
// res.ok => message published
data := new(struct{ID string `json:"id"`})
data.ID = "some-id-related-to-what-user-is-doing"
if err := backend.Publish(
token,
"unlock-action", "xyz-created",
data); err != nil {
//...
}
Response:
true
© 2023 Focus Centric Inc. All rights reserved.
