BUZZY REST API - The Rough Guide!

Full documentation coming soon… for now

eg curl https://buzzy.buzz:/api/login/ -d “email=&password=”

you need to send email/password in the body of the POST call

{
"email":"<buzzy email address>",
"password":"<buzzy password>"
}

eg

POST /api/login HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Cache-Control: no-cache
Postman-Token: a4b2c260-0c8c-6e41-da1c-9bd09808f5ff


{
"email":"adam.ginsburg@gmail.com",
"password":"password"
}

You should get back something like:

{  

    "status": "success",  

    "data": 

    {    

        "authToken": "<token>",

        "userId": "<user id returned>"

   }

}

Then use the authToken and userId to POST to https://buzzy.buzz/api/createbuzz using the token & userId you got back above to make the call with the following params:

{

"participants": {
    "audience": [],
    "authors": [],
    "owners": ["<owner email address>"]
},
"templateID":"<enter your Buzzy template ID eg <somelongstring>",
"title":"<enter your title>"
}

eg POST (note X-Auth-Token and X-User-Id param names have changed for the second call)

reserved word for RowID [_id]

POST /api/createbuzz HTTP/1.1
Host: localhost:3000
X-Auth-Token: <the authtoken you got back after authentication>
X-User-Id: no6DsbNtrHFYJaDHr
Content-Type: application/json
Cache-Control: no-cache
Postman-Token: 593d953c-7e15-fa65-c7c8-6e265af5fd60

{

"participants": {
    "audience": [],
    "authors": [],
    "owners": ["<owner email address>"]
},
"templateID":"<template id>",
"title":"Test Create Buzz 1"
}

Updatingfield values using the API

URI : https://<buzzyURL>/api/updatemicroapprow

the JSON body consists of rowID and rowData. The field names need to match (case sensitive) to the Buzzy field labels.

{

"rowID":"9860757f2bf858439ed9cc3e",
"rowData":{
"Name":"Fred"
}
}

Postman example:

POST /api/updatemicroapprow HTTP/1.1
Host: localhost:3000
X-Auth-Token: kYAXTxY3oxhA9TZxncXkh6XGiqhi8zRc1SsPf2Mn9SG
X-User-Id: 7c01016656418610c521ab71
Content-Type: application/json
Cache-Control: no-cache
Postman-Token: 2ec252b7-a1cc-cc5e-db5e-d656ceeeba61

{

"rowID":"9860757f2bf858439ed9cc3e",
"rowData":{
"Name":"Fred"
}
}

API call for insertmicroapprow

Get the “microAppID” by going to the micro app’s properties, “General” tab. Copy that ID for posting to that specific microApp.

URI : https://<buzzyURL>/api/insertmicroapprow

{

"microAppID":"9860757f2bf858439ed9cc3e",
"rowData":{
"Name":"Fred"
},

"ignoreActionRules":true
}

Example of dates value for either update or insert:

If single date eg “Simple date/time” then the value of a field should be “{val:}”

For example, setting “DOB” date/time field:

 {

"rowID":"6d8aef510b54d57b1a32fce8",
"rowData":{
"DOB":{"val":1517883803142}
}
}

if the field has a start & end time, then you need to use ‘{“start”:, “end”:}’

Epoch numeric values - eg in JavaScript “new Date().getTime()”