New API Documentation released.

We have released new documentation in Postman this week. A quick peek preview.

NIZU Cloud API

NIZU Cloud API Clients

🚀 Get started here

This collection guides you through CRUD operations (GET, POST, PUT, DELETE), variables, and tests.

🔖 How to use this collection

Step 1: Send requests

RESTful APIs allow you to perform CRUD operations using the POST, GET, PUT, and DELETE HTTP methods.

This collection contains each of these request types. Open each request and click “Send” to see what happens.

Step 2: View responses

Observe the response tab for status code (200 OK), response time, and size.

Step 3: Send new Body data

Update or add new data in the “Body” of the POST request. Body data is also typically used in PUT and PATCH requests.

json

{
    "field": "name",
    "value":"My company"
}

Step 4: Update the variable

Variables enable you to store and reuse values in Postman. We have created a variable called base_url with the sample request https://postman-api-learner.glitch.me. Replace it with your API endpoint to customize this collection.

Step 5: Add tests in the “Tests” tab

Tests help you confirm that your API is working as expected. You can write test scripts in JavaScript and view the output in the “Test Results” tab.

đŸ’Ē Pro tips

  • Use folders to group related requests and organize the collection.
  • Add more scripts in “Tests” to verify if the API works as expected and execute flows.

Basic understanding

HTTP MethodFunction
GETUse to retrive data, and execute functions
POSTInserts data only
PUTUpdates data
DELDeletes Data [ Almost never allowed ]

Basic payload structure

json

{
    "module":"The module you are going to affect"
    "data":[
         ... Your data payload 
    ]
,
    
}

ℹī¸ Resources

Building requests
Authorizing requests
Using variables
Managing environments
Writing scripts

POSTCreate Client

https://postman-rest-api-learner.glitch.me

This is a POST request, submitting data to an API via the request body. This request submits JSON data, and the data is reflected in the response.

A successful POST request typically returns a 200 OK or 201 Created response code.

AUTHORIZATIONBearer Token

Token

{{client_token}}

Bodyraw (json)View More

json

{
	"module": "clients",
    "data":[
        {
            "field":"company",
            "value":"Company test"
        },
        {
            "field":"vat",
            "value":""
        },
        {
            "field":"phonenumber",
            "value":"1555555555"
        },
        {
            "field":"country",
            "value":"23"
        },
        {
            "field":"city",
            "value":"Brussels"
        },
        {
            "field":"zip",
            "value":"1000"
        },
        {
            "field":"state",
            "value":"Brussels"
        },
        {
            "field":"address",
            "value":"Rue Royale 265"
        },
        {
            "field":"website",
            "value":"https://mywebsite.com"
        },
        {
            "field":"datecreated",
            "value":"NOW()"
        },
        {
            "field":"active",
            "value":"1"
        },
        {
            "field":"leadid",
            "value":"12"
        },
        {
            "field":"billing_street",
            "value":"Rue Royale 265"
        },
        {
            "field":"billing_city",
            "value":"Brussels"
        }
    ]
}

Example Request

Create ClientView More

curl

curl --location 'https://postman-rest-api-learner.glitch.me/' \
--data '{
	"module": "clients",
    "data":[
        {
            "field":"company",
            "value":"Company test"
        },
        {
            "field":"vat",
            "value":""
        }
    ]
}'

200 OK

Example Response

  • Body
  • Headers (9)

json

{
  "success": true,
  "data": {
    "id": 88
  }
}

GETGet Client(s)

https://postman-rest-api-learner.glitch.me

This is a POST request, submitting data to an API via the request body. This request submits JSON data, and the data is reflected in the response.

A successful POST request typically returns a 200 OK or 201 Created response code.

AUTHORIZATIONBearer Token

Token

{{client_token}}

Bodyraw (json)

json

{
	"module": "clients",
    "data":{}
}

Bookmark our page for more update!