YouLocateMe API Documentation

Welcome to the YouLocateMe API documentation. This guide provides detailed instructions on how to integrate our location ID system into your application. YouLocateMe API enables you to register new addresses, retrieve stored addresses, and manage location IDs efficiently.

Base URL

https://app.youlocate.me/api/v1

Headers

          Content-Type: application/json
              

Endpoints

1. Register a New Address

Endpoint: /register

Method: POST

Description: Registers a new address and returns a unique location ID.

Request Body:

          {
            "homeName": "My Home",
            "billingAddress": {
              "street": "123 Street",
              "city": "City",
              "zip": "12345",
              "country": "Country"
            }
          }
              

Response:

          {
            "locationId": "myhome@locateme"
          }
              

Example Request:

          curl -X POST https://app.youlocate.me/api/v1/register \
          -H "Content-Type: application/json" \
          -d '{
            "homeName": "My Home",
            "billingAddress": {
              "street": "123 Street",
              "city": "City",
              "zip": "12345",
              "country": "Country"
            }
          }'
              

2. Retrieve Address

Endpoint: /address/{locationId}

Method: GET

Description: Retrieves the address details for the given location ID.

Path Parameter:

• locationId: The unique location ID assigned during registration.

Response:

          {
            "homeName": "My Home",
            "billingAddress": {
              "street": "123 Street",
              "city": "City",
              "zip": "12345",
              "country": "Country"
            }
          }
              

Example Request:

          curl -X GET https://app.youlocate.me/api/v1/address/myhome@locateme \
          -H "Content-Type: application/json"
              

3. Update Address

Endpoint: /address/{locationId}

Method: PUT

Description: Updates the address details for the given location ID.

Path Parameter:

• locationId: The unique location ID assigned during registration.

Request Body:

          {
            "homeName": "My Updated Home",
            "billingAddress": {
              "street": "456 New Street",
              "city": "New City",
              "zip": "67890",
              "country": "New Country"
            }
          }
              

Response:

          {
            "message": "Address updated successfully"
          }
              

Example Request:

          curl -X PUT https://app.youlocate.me/api/v1/address/myhome@locateme \
          -H "Content-Type: application/json" \
          -d '{
            "homeName": "My Updated Home",
            "billingAddress": {
              "street": "456 New Street",
              "city": "New City",
              "zip": "67890",
              "country": "New Country"
            }
          }'
              

4. Delete Address

Endpoint: /address/{locationId}

Method: DELETE

Description: Deletes the address associated with the given location ID.

Path Parameter:

• locationId: The unique location ID assigned during registration.

Response:

          {
            "message": "Address deleted successfully"
          }
              

Example Request:

          curl -X DELETE https://app.youlocate.me/api/v1/address/myhome@locateme \
          -H "Content-Type: application/json"
              

Error Handling

Common Error Responses:

• 400 Bad Request: The request could not be understood or was missing required parameters.
• 401 Unauthorized: Authentication failed or user does not have permissions for the requested operation.
• 404 Not Found: The specified location ID could not be found.
• 500 Internal Server Error: An error occurred on the server.

Example Error Response:

          {
            "error": "Invalid location ID"
          }
              

Conclusion

The YouLocateMe API provides a simple and secure way to manage addresses using unique location IDs. By integrating our API, you can enhance your application's address management capabilities, providing users with a seamless and efficient experience. If you have any questions or need further assistance, please contact our support team at support@youlocate.me.