Common API Examples
This page shows the same common operations across the three main Buzzy API styles:
BuzzyFrameAPI (Async) for client-side code widgets
REST API for direct HTTP integrations
Node.js API Client for server-side JavaScript wrappers
Use the REST API pages as the canonical reference for shared row semantics:
Authentication Setup
BuzzyFrameAPI (Async)
const buzzyFrameAPI = new BuzzyFrameAPI();
await buzzyFrameAPI.initialise();REST API
const loginResponse = await fetch('https://your-buzzy-instance.com/api/login', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
email: 'user@example.com',
password: 'password'
})
});
const loginResult = await loginResponse.json();
const { authToken, userId } = loginResult.data;Node.js API Client
Token Handling
REST API
Use the authToken and userId returned from login on authenticated requests:
Node.js API Client
Pass the same values as method arguments:
Logout
REST API
Node.js API Client
Create a New Contact
BuzzyFrameAPI (Async)
REST API
Node.js API Client
Read/Fetch Contacts
BuzzyFrameAPI (Async)
REST API
Node.js API Client
Update a Contact
BuzzyFrameAPI (Async)
REST API
Node.js API Client
Delete a Contact
BuzzyFrameAPI (Async)
REST API
Node.js API Client
Metadata-Aware Row Access
Rows returned by Buzzy can include business fields and system-managed metadata such as _id, userID, submitted, clientSubmitted, and embeddingRowID.
See Row Metadata and Relationships for the canonical definition.
REST API
Node.js API Client
Working with embeddingRowID
Use embeddingRowID for sub-table parent-child relationships.
Create a Child Row
BuzzyFrameAPI (Async)
REST API
Node.js API Client
Read Child Rows for One Parent
BuzzyFrameAPI (Async)
REST API
Node.js API Client
Linked-Table Field Example
Use linked-table fields when you want to reference a row in another Datatable. This is different from embeddingRowID.
REST API
See microappdata/row for the response shape.
See Also
Last updated