API Playground

Enable users interact with your API

Introduction

The API playground lets you create an interactive environment to make requests and preview your API endpoints.

GET

/api/hello

message

Tes GET endpoint hello with message as param

GET

/api/users/1

Tes GET endpoint users/1 that will return user data with id 1

GET

/api/users

Tes GET endpoint users with id as param. If no id was specified it will return all users data

POST

/api/users

Tes POST to endpoint users

PUT

/api/users

Tes PUT to endpoint users

PATCH

/api/users

Tes PATCH to endpoint users

DELETE

/api/users/1

Tes DELETE to endpoint users

Request / Response

Request

curl --request GET \
	--url https://api.vessel.land/connection/crm/integrations \
	--header 'Content-Type: application/json'

Response

{
	"id": "573de1b49555e84fccd76c47f8bac0a2",
	"nativeId": "23",
	"firstName": "Tom",
	"lastName": "Smith",
	"jobTitle": "Director of Operations",
	"email": "tom@bluecross.com",
	"account": "Blue Cross",
	"phone": "1234445555",
	"associations": {
		"contactIds": [
			"3e530bfc11fdb21bbc8d28dd6dde491a"
		]
	},
	"additional": {}
}

{
	"id": "72be9d5c-f7c7-4d53-bafc-8846232ee02b",
	"utility": {
		"id": 1,
		"full_name": "Pacific Gas & Electricity"
	},
	"utility_username": "user@pelm.com",
	"credentials_valid": true
}

Method

Can be any one of the following REST API methods

Method	Description
GET	Retrieve information about the REST API resource
POST	Create a REST API resource
PUT	Update a REST API resource
PATCH	Update a REST API resource
DELETE	Delete a REST API resource or related component

Endpoint

The endpoint should point to the API that the playground should call. For example, it can be something like

https://api.example.com/v1/endpoint

If you have baseUrl configured in next.config.js, you can use relative paths like {baseUrl}/v1/endpoint.

Example Template