๐ค Robot Services Exchange (RSX) FAQ
General Information
What is the Robot Services Exchange (RSX)?
The Robot Services Exchange (RSX) is a new platform that connects individuals or businesses in need of robot services (buyers) with robot owners or operators (sellers). It serves as a marketplace where buyers can post service requests, and sellers can offer their robots' capabilities to fulfill these requests. RSX streamlines the process of finding, hiring, and managing robot services across various industries, enabling efficient and cost-effective solutions.
How does RSX work?
RSX operates through a dynamic bidding and matching system:
- Bid Submission: Buyers post service requests by submitting bids, specifying details such as the type of service required, location, desired price, and the deadline for completion.
- Job Search: Robot owners (sellers) can search for available bids that match their robots' services and operational area.
- Matching and Acceptance: The system matches bids to robots based on service compatibility, location proximity, and pricing.
- Job Execution: Once matched, the robot is dispatched to perform the requested service as per the agreed terms.
- Completion and Rating: Upon completion, both buyers and sellers can rate each other, providing feedback to maintain quality and trust within the platform.
This system ensures efficient allocation of robot services, competitive pricing, and transparent transactions between buyers and sellers.
What types of robot services are available on RSX?
RSX supports a wide range of robot services across multiple industries, including but not limited to:
- ๐งน Cleaning and Maintenance: Floor cleaning, window washing, waste disposal.
- ๐ฆ Delivery and Logistics: Package delivery, inventory management, warehouse operations.
- ๐ Security and Surveillance: Patrol services, monitoring, threat detection.
- ๐พ Agriculture: Crop monitoring, planting, harvesting.
- ๐๏ธ Construction: Site surveying, material handling.
- ๐๏ธ Personal Services: Tutoring, personal shopping, event assistance.
The platform is continually expanding to include more service categories as robotic technology advances.
Getting Started
How do I get started with RSX?
To get started, you need to create an account on RSX:
- Registration: Sign up by providing your username and password via the
/register
endpoint.
- Authentication: Log in using your credentials through the
/login
endpoint to obtain an authentication token.
- Start Using RSX: Begin posting bids for services or searching for available jobs.
For Buyers and Sellers
How do buyers place a bid for a robot service?
Buyers can place a bid using the
/make_bid
endpoint. Here's how:
- Ensure you have registered and logged in to obtain an authentication token.
- Prepare your bid data, including:
- service: The type of service you need (e.g., "cleaning", "delivery").
- lat: Latitude of the service location.
- lon: Longitude of the service location.
- price: Your bid price for the service (in USD).
- end_time: The deadline for the service (Unix timestamp).
- Send a POST request to
/make_bid
with your bid data in JSON format, including your authentication token in the header.
Example bid payload:
{
"service": "delivery",
"lat": 37.7749,
"lon": -122.4194,
"price": 75.00,
"end_time": 1700000000
}
How do sellers find and accept jobs?
Sellers can find jobs using the
/grab_job
endpoint. Here's how:
- Ensure you have registered and logged in to obtain an authentication token.
- Prepare your robot's data, including:
- service: The services your robot can perform (comma-separated if multiple).
- lat: Current latitude of your robot.
- lon: Current longitude of your robot.
- max_distance: Maximum distance (in miles) your robot can travel for a job.
- Send a POST request to
/grab_job
with your robot's data in JSON format, including your authentication token in the header.
Example grab job request:
{
"service": "cleaning,delivery",
"lat": 34.0522,
"lon": -118.2437,
"max_distance": 15
}
If a matching job is found, the response will include job details:
{
"job_id": "987f6543-e21b-65d4-c321-654987321000",
"service": "cleaning",
"lat": 34.0500,
"lon": -118.2500,
"price": 100.00,
"end_time": 1700005000,
"buyer_username": "client_123",
"status": "won"
}
How do I rate or provide feedback after a job?
After a job is completed, both buyers and sellers can rate each other using the
/sign_job
endpoint. Here's how:
- Ensure you have your authentication token.
- Prepare your rating data, including:
- job_id: The ID of the job you are rating.
- password: Your account password (for verification).
- star_rating: Your rating (e.g., 1 to 5 stars).
- comments: (Optional) Additional feedback.
- Send a POST request to
/sign_job
with your rating data in JSON format, including your authentication token in the header.
Example rating submission:
POST /sign_job
Headers: Authorization: Bearer <your_token>
{
"job_id": "abc123def456ghi789",
"password": "your_password",
"star_rating": 5,
"comments": "Excellent service! Highly recommended."
}
RSX Protocol Details
How does the RSX protocol match bids to robots?
The RSX protocol matches bids to robots through the following process:
- Bid Storage: Buyers' bids are stored with details like service type, location, price, and end time.
- Seller Search: Sellers use
/grab_job
to search for jobs matching their robots' capabilities and location.
- Matching Criteria: The system filters bids based on:
- Service Compatibility: The robot's services must match the bid's service requirements.
- Location Proximity: The job must be within the robot's maximum travel distance.
- Time Constraints: The robot must be able to complete the job before the bid's end time.
What are the key API endpoints and their usage?
RSX provides several RESTful API endpoints:
- Authentication:
/register
(POST): Register a new user account.
/login
(POST): Authenticate and receive an access token.
- Buyer Actions:
/make_bid
(POST): Submit a new bid for a service.
/nearby
(POST): View recent activities and bid status.
/sign_job
(POST): Confirm job completion and rate the counterparty.
- Seller Actions:
/grab_job
(POST): Search for and accept available jobs.
/sign_job
(POST): Confirm job completion and rate the counterparty.
- Utility:
/ping
(GET/POST): Check API connectivity.
Remember to include your authentication token in the request headers where required.
How is authentication handled in RSX?
RSX uses token-based authentication:
- Register: Create an account via the
/register
endpoint.
- Login: Obtain an access token using the
/login
endpoint.
- Token Usage: Include the access token in the
Authorization
header of API requests:
Authorization: Bearer your_access_token
- Token Expiry: Tokens are valid for a limited time and can be renewed by logging in again.
Technical Information
What technologies does RSX use?
RSX is built using modern technologies:
- Backend: Python with the Flask framework.
- Database: Redis for fast, in-memory data storage.
- Server: Gunicorn as the WSGI HTTP server.
- Frontend: HTML, CSS, and JavaScript with Leaflet for mapping.
- API Communication: RESTful API endpoints for client-server interactions.
- Authentication: Token-based authentication for secure access.
This stack ensures scalability, efficiency, and security for the RSX platform.
How can I integrate my application with RSX?
To integrate your application:
- Obtain API Access: Register and log in to get an access token.
- Review Documentation: Familiarize yourself with the API endpoints and data formats.
- Use SDKs: Utilize available SDKs or build your own client to interact with the API.
- Testing: Test your integration in the sandbox environment.
Troubleshooting and Support
I'm experiencing issues with the API. What should I do?
If you're encountering API issues:
- Check Your Code: Ensure your requests comply with the API documentation.
- Validate Data: Verify that you're sending the correct data formats and required fields.
- Use /ping Endpoint: Test connectivity using the
/ping
endpoint.
- Contact Support: If issues persist, seek assistance from the RSX support team.
Where can I find more information or updates about RSX?
Back to Top