ServerDirect API

Introduction

Welcome to the ServerDirect API documentation. This API provides access to your RMA data. Below are detailed descriptions and usage examples of the API endpoints.

Base URL

The base URL for accessing the API is:

https://www.serverdirect.nl/api/v1

Authentication

All API requests must be authenticated. You can authenticate your requests by including the Authorization header with a valid API key. Request your key here. You will need your customer ID which can be found in the client center > account details.

Example:

Authorization: [api_key]

Endpoints

/RMA

GET Request

Retrieve information based on the member ID.

Request:

GET https://www.serverdirect.nl/api/v1/rma?member_id={member_id}

Example:

curl -X GET "https://www.serverdirect.nl/api/v1/rma?member_id={member_id}" -H "Authorization: {api_key}"

Parameters:

• member_id (string, required): The ID of the member for which the information is requested.

Response sample:

{
  "status": "success",
  "data": {
    "member_id": "832278396576dcc49078b",
    "description": "Sample description",
    "company_name": "Company Inc.",
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "1234567890",
    "delivery_address": "123 Street",
    "invoice_number": "INV123456",
    "warranty_type": "Full",
    "invoice_date": "2024-01-01",
    "order_number": "ORD987654",
    "product_code": "PC1234",
    "product_description": "Product Description",
    "serial_number": "SN123456",
    "date": "2024-01-01",
    "client_reference": "My own reference"
  }
}

POST Request

Submit information to the API.

Request:

POST https://www.serverdirect.nl/api/v1/rma

Example:

curl -X POST "https://www.serverdirect.nl/api/v1/rma" -H "Authorization: {api_key}" -H "Content-Type: application/json" -d '{
  "member_id": "{member_id}",
  "description": "Sample description",
  "company_name": "Company Inc.",
  "name": "John Doe",
  "email": "john@example.com",
  "phone": "1234567890",
  "delivery_address": "123 Street",
  "invoice_number": "INV123456",
  "warranty_type": "Full",
  "invoice_date": "2024-01-01",
  "order_number": "ORD987654",
  "product_code": "PC1234",
  "product_description": "Product Description",
  "serial_number": "SN123456",
  "date": "2024-01-01",
  "client_reference": "My own reference"
}'

Headers:

• Authorization (string, required): The API key for authentication.
• Content-Type (string, required): Must be application/json.

Request Body:

• member_id (string, required): The ID of the member.
• description (string, required): Description of the request.
• company_name (string, required): Name of the company.
• name (string, required): Name of the contact person.
• email (string, required): Email address of the contact person.
• phone (string, required): Phone number of the contact person.
• delivery_address (string, required): Delivery address.
• invoice_number (string, required): Invoice number.
• warranty_type (string, required): Type of warranty.
• invoice_date (string, required): Date of the invoice (format: YYYY-MM-DD).
• order_number (string, required): Order number.
• product_code (string, required): Product code.
• product_description (string, required): Description of the product.
• serial_number (string, required): Serial number of the product.
• date (string, required): Date of the request (format: YYYY-MM-DD).
• client_reference (string, required): Your own reference.

Response:

{
  "status": "success",
  "message": "Data submitted successfully",
  "data": {
    "member_id": "1",
    "description": "Sample description",
    "company_name": "Company Inc.",
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "1234567890",
    "delivery_address": "123 Street",
    "invoice_number": "INV123456",
    "warranty_type": "Full",
    "invoice_date": "2024-01-01",
    "order_number": "ORD987654",
    "product_code": "PC1234",
    "product_description": "Product Description",
    "serial_number": "SN123456",
    "date": "2024-01-01",
    "client_reference": "My own reference"
  }
}

Error Handling

In case of an error, the API will return an appropriate HTTP status code along with a JSON response containing the error details.

Example:

{
  "status": "error",
  "message": "Invalid member_id provided"
}

Contact

For any questions or support, please contact our API support team at support@serverdirect.nl.

Conclusion

This documentation provides a comprehensive overview of the ServerDirect API. Ensure you include the required headers and parameters when making requests. For further assistance, do not hesitate to reach out to our support team.