Bit form API

An API (Application Protocol Interface) defines a set of functions that interact with other software components or applications or you can call microservices between web applications. If any web application or software needs any information from another software, they have to make a call or request to get the information. This specific call or request is called API.

To simplify this context, we can take an example that a user installed a form plugin from which he/she wants to deliver form data to our Bit Form plugin where the user has already made a form. What the user has to do is to make an API request to Bit Form. In response, users will get all the data that they have requested will be stored in Bit Form.

API Key Option​

1. Go to Bit form Settings and then navigate to API
2. Copy your API Key then use it in the request header.

API Endpoints​

Get Forms

To fetch all forms.

https://{base_url}/wp-json/bitform/v1/forms

{
"forms": [
{
"form_name": "Contact Form"
"id": "1"
}
],
"status": 200,
"code": 4000,
"sucess":true
}

Fetch Entries​

Fetch all entries by specific form ID.

https://{base_url}/wp-json/bitform/v1/form/response/{form_id}

{
"data": {
"count":"95",
"entries":[
{
"entry_id":"12",
"bf1-1":"test data"
},
…
]
},
"status": 200,
"sucess": true
}

Get Form Fields​

Fetch all fields of a specific form.

https://{base_url}/wp-json/bitform/v1/fields/{form_id}

{
  "data": {
    "fields": {
      "bf1-1-": {
        "typ": "txt",
        "lbl": "First Name",
        "ph": "Enter Your First Name",
        "valid": {}
      }
    },
    "fieldkeys": {
      "bf1-1-": "bf1-1-"
    },
    "workflows": [
      {
        "workflow_name": "workflow 2",
        "id": "2"
      }
    ],
    "workflow_key_name": "workflow"
  },
  "status": 200,
  "code": 4000,
  "sucess": true
}

Add record/entries​

Add entries to a specific form.

https://{base_url}/wp-json/bitform/v1/entry/{form_id}

{
  "status": 200,
  "code": 4000,
  "message": "Data Added Successfully.",
  "sucess": true
}

Edit record/entries

https://{base_url}/wp-json/bitform/v1/entry_update/{form_id}

{
  "status": 200,
  "code": 4000,
  "message": "Data Updated Successfully",
  "sucess": true
}

Delete records/entries

https://{base_url}/wp-json/bitform/v1/entry_delete/{form_id}

{
  "status": 200,
  "code": 4000,
  "message": "Data Deleted Successfully",
  "sucess": true
}

Get workflow or conditional logic

This api is used to get the list of all the workflow in the system.

https://{base_url}/wp-json/bitform/v1/workflow/{form_id}

Response:
{
    "workflow": [
        {
            "id": "72",
            "workflow_name": "Action 2",
            "workflow_type": "onsubmit",
            "workflow_run": "create_edit",
            "workflow_behaviour": "always"
        },
        {...}
}

Add Record/Entries with workflow or conditional logic

This api is used to add record/entries in the form with workflow or conditional logic.

https://{base_url}/wp-json/bitform/v1/entry/{form_id}

Response:
{
    "success": true,
    "data": {
        "entry_id": 530,
        "message": "Form Submitted Successfully",
        "msg_id": 0
    }
}

API Status Codes​

The success or failure of an API request is conveyed by the code and message in its response.

Watch a demo tutorial here!

🖐 Let us know if you have any feedback or any API requests at [email protected].