Complete REST API reference with authentication, endpoints, and code examples in multiple languages
Sign up for a free account to get your API key. You can find it in your dashboard under Settings → API Keys.
Get API KeyAll API requests require authentication using Bearer tokens. Include your API key in the Authorization header:
// Authentication using JWT Token
const response = await fetch('https://api.srapsware.com/api/users', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);Try fetching the list of users with the example below:
// JavaScript/Node.js Example
const fetch = require('node-fetch');
async function getUsers() {
const response = await fetch('https://api.srapsware.com/api/users', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);
}
getUsers();/api/usersRetrieve a list of all users
pageintegerPage number (default: 1)
limitintegerItems per page (default: 20)
searchstringSearch query
{
"users": [
{
"id": 1,
"name": "John Doe",
"email": "john@example.com",
"createdAt": "2024-01-15T10:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 100
}
}/api/usersCreate a new user
namestringRequiredUser's full name
emailstringRequiredUser's email address
passwordstringRequiredUser's password (min 8 characters)
{
"id": 101,
"name": "John Doe",
"email": "john@example.com",
"createdAt": "2024-01-15T10:30:00Z",
"message": "User created successfully"
}/api/users/:idGet a specific user by ID
idintegerRequiredUser ID
{
"id": 1,
"name": "John Doe",
"email": "john@example.com",
"role": "admin",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-20T14:20:00Z"
}/api/users/:idUpdate an existing user
namestringUser's full name
emailstringUser's email address
{
"id": 1,
"name": "John Smith",
"email": "johnsmith@example.com",
"updatedAt": "2024-01-22T16:45:00Z",
"message": "User updated successfully"
}/api/users/:idDelete a user
idintegerRequiredUser ID
{
"message": "User deleted successfully",
"deletedAt": "2024-01-22T17:00:00Z"
}| Code | Description |
|---|---|
200 | OK - Request successful |
201 | Created - Resource created successfully |
400 | Bad Request - Invalid request parameters |
401 | Unauthorized - Invalid or missing API key |
403 | Forbidden - Insufficient permissions |
404 | Not Found - Resource does not exist |
429 | Too Many Requests - Rate limit exceeded |
500 | Internal Server Error - Something went wrong |