Database Service

Overview

This API service allows clients to interact with a database using various query operations such as Select, Create, and Update. The service utilizes cURL for making HTTP requests and PHP's PDO for database interactions.

Endpoints

API URL: https://database.thinkinsurance.co.uk/Request.php

Authentication

The API uses Bearer Token authentication. Include the token in the Authorization header of each request.

cURL Request Example

		
curl -X POST \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
	"Credentials": {
		"Username": "your_username",
		"Password": "your_password"
	},
	"Request": "Select",
	"RequestPacket": {
		"Connection_ID": 1,
		"Query_ID": 1,
		"BindParams": {
			":Template_ID": 1
		}
	}
}' \
https://database.thinkinsurance.co.uk/Request.php

Requesting Page Example

The requesting page script processes incoming requests and interacts with the database service. Here's how it works:

Extract the headers and request packet from the incoming HTTP request.
Include the necessary source files for database connection and query handling.
Check if the requested method exists and is public within the specified class.
If the method exists, execute it with the provided parameters and return the result.
If the method does not exist, return an error message indicating the invalid request.

Options for Select, Update, and Create

For each of the following operations, provide the Request parameter as follows:

Select: Use 'Select' to retrieve data from the database.
Create: Use 'Create' to insert new data into the database.
Update: Use 'Update' to modify existing data in the database.

JSON Payload Examples

Select Example

			
{
	"Credentials": {
		"Username": "your_username",
		"Password": "your_password"
	},
	"Request": "Select",
	"RequestPacket": {
		"Connection_ID": 1,
		"Query_ID": 1,
		"BindParams": {
			":Template_ID": 1
		}
	}
}

Create ExampleCreate Example


{
	"Credentials": {
		"Username": "your_username",
		"Password": "your_password"
	},
	"Request": "Create",
	"RequestPacket": {
		"Connection_ID": 2,
		"Query_ID": 2,
		"BindParams": {
			":Template_Name": "New Template",
			":Template_Output": "Template Output"
		}
	}
}

Update Example


{
	"Credentials": {
		"Username": "your_username",
		"Password": "your_password"
	},
	"Request": "Update",
	"RequestPacket": {
		"Connection_ID": 3,
		"Query_ID": 3,
		"BindParams": {
			":Template_ID": 1,
			":Template_Name": "Updated Template",
			":Template_Output": "Updated Output"
		}
	}
}

Validation Guidelines

When using the API service, adhere to the following guidelines for proper usage:

MUST: Provide valid authentication credentials including username and password.
MUST: Include the Bearer Token in the Authorization header for each request.
MUST NOT: Expose sensitive information such as passwords or tokens in plain text.
MUST NOT: Make requests to endpoints without proper authentication.
MUST NOT: Modify the source code of the service without proper authorization.
GOOD REQUEST EXAMPLE:


{
	"Credentials": {
		"Username": "your_username",
		"Password": "your_password"
	},
	"Request": "Select",
	"RequestPacket": {
		"Connection_ID": 1,
		"Query_ID": 1,
		"BindParams": {
			":Template_ID": 1
		}
	}
}

BAD REQUEST EXAMPLE:


{
	"Credentials": {
		"Username": "your_username",
		"Password": "your_password"
	},
	"Request": "Update",
	"RequestPacket": {
		"Connection_ID": 2,
		"Query_ID": 2,
		"BindParams": {
			":Template_ID": 1,
			":Template_Name": "New Template"
		}
	}
}