Crossdesk Relais API

Within the .NET Core class library, there is a specific controller named “PickUpPointController.” This controller encapsulates a set of 12 methods that handle various operations and functionalities related to pick-up points.

Methods are below with their descriptions:

1. GetPickUpPointByPostalCode
2. GetPickUpPointType
3. GetServices
4. GetShopifyProducts
5. GetNearestLocation
6. GetAddressFromPoint
7. UploadImage
8. RemoveImage
9. UploadServiceImage
10. RemoveServiceImage
11. CarrierServiceLabel
12. ShopifyAuth
13. ShopifyAuthorize

GetPickUpPointByPostalCode:

The “GetLocations” method within the “PickUpPointController” in the .NET Core class library serves the purpose of retrieving service locations based on the latitude and longitude of the user’s shop location. Additionally, it provides the flexibility for the user to modify the limit of records returned and add new services. Furthermore, the method allows for the inclusion or exclusion of location images in the retrieved records, based on the user’s preference.

You can pass below parameters in this end point.

Latitude : string

Longtitude : string

Services : string

allowImage : boolean

limit : int

GetPickUpPointTypeList:

When a user wants to retrieve a list of pick-up point types, they can make an HTTP GET request to the corresponding route, which is “/GetPickUpPointTypeList”. This can be done through a web browser, an API client, or any tool that can send HTTP requests.

Once the user sends the request, the method executes asynchronously, meaning it doesn’t block the application’s execution while waiting for the data. It calls a service called “pickUpPointTypeService” to fetch the list of pick-up point types.

The “pickUpPointTypeService” service is responsible for interacting with the data source, such as a database, to retrieve the pick-up point types. It performs any necessary operations to fetch the data efficiently.

After the list of pick-up point types is retrieved from the service, the method constructs a response indicating that the request was successful by returning an “Ok” result. The retrieved pick-up point type data is included in the response body, allowing the user to see the list of available pick-up point types.

In summary, this method provides a way for users to get a list of pick-up point types by sending an HTTP GET request to the specified route. The method communicates with a service to fetch the data and returns the retrieved list as a response to the user’s request.

GetServices :

To retrieve a list of services, the user can send an HTTP GET request to the corresponding route, which is “/GetServices”. This can be done using a web browser, an API client, or any tool capable of sending HTTP requests.

Upon receiving the request, the method executes asynchronously, meaning it doesn’t block the application’s execution while waiting for the data. It calls a service named “carrierServiceService” to fetch the list of services.

The “carrierServiceService” service is responsible for interacting with a data source, such as a database, to retrieve the desired service information. It performs the necessary operations to efficiently fetch the data.

Once the list of services is retrieved from the service, the method constructs a response indicating that the request was successful by returning an “Ok” result. The retrieved service data is included in the response body, allowing the user to see the list of available services.

In summary, this method provides a way for users to retrieve a list of services by sending an HTTP GET request to the specified route. The method communicates with a service to fetch the data and returns the retrieved list as a response to the user’s request.

GetShopifyProducts:

To retrieve products from the Shopify platform, the user can send an HTTP GET request to the corresponding route, which is “/GetShopifyProducts”. This can be done using a web browser, an API client, or any tool capable of sending HTTP requests.

Upon receiving the request, the method performs the following steps:

It creates a new instance of the HttpClient class, which is used to send HTTP requests.

It creates an HttpRequestMessage object, specifying that it’s an HTTP GET request and providing the URL for the Shopify API endpoint that retrieves product data.

It adds an “X-Shopify-Access-Token” header to the request, which is used for authentication with Shopify. The token allows access to the specific Shopify store associated with the provided access token.

It prepares an empty content body with a content type of “application/json”.

It assigns the prepared content to the request’s Content property.

It sends the prepared request asynchronously using the SendAsync method of the HttpClient instance.

It ensures that the response received from Shopify indicates success by calling EnsureSuccessStatusCode(). If the response is not successful, an exception will be thrown.

It returns an “Ok” result, indicating that the request was successful.

The response content, which contains the retrieved product data in JSON format, is converted to a string using ReadAsStringAsync(). This data is then included in the response body.

GetNearestLocation:

The code snippet represents a method called “GetNearestLocation” within a .NET Core application’s controller. This method is designed to handle an HTTP GET request made by a user.

To find the nearest location based on a search query, the user can send an HTTP GET request to the corresponding route, which includes a parameter for the search query (“/GetNearestLocation/{search}”). This can be done using a web browser, an API client, or any tool capable of sending HTTP requests.

Upon receiving the request, the method performs the following steps:

1. It creates a new instance of the HttpClient class, which is used to send HTTP requests.
2. It creates an HttpRequestMessage object, specifying that it’s an HTTP GET request and providing the URL for the Virtual Earth REST API endpoint that performs the location search.
3. It adds an “Authorization” header to the request, which includes a Basic authentication token. The token is used to authenticate with the Virtual Earth API.
4. It prepares an empty content body.
5. It assigns the prepared content to the request’s Content property.
6. It sends the prepared request asynchronously using the SendAsync method of the HttpClient instance.
7. It ensures that the response received from the Virtual Earth API indicates success by calling EnsureSuccessStatusCode(). If the response is not successful, an exception will be thrown.
8. It returns an “Ok” result, indicating that the request was successful.
9. The response content, which contains the retrieved location data in JSON format, is converted to a string using ReadAsStringAsync(). This data is then included in the response body.

In summary, this method provides a way for users to find the nearest location based on a search query. It sends an HTTP GET request to the Virtual Earth REST API endpoint, authenticates using the provided Basic authentication token, and returns the retrieved location data as a response to the user’s request.

You can pass below parameter in this end point.

search: string

GetAddressFromPoint:

The code snippet represents a method called “GetAddressFromPoint” within a .NET Core application’s controller. This method is designed to handle an HTTP GET request made by a user and accepts two parameters: “latitude” of type double and “longitude” of type double.

To use this method, you need to include the latitude and longitude values as part of the URL when making the request. For example, if you want to get the address from a specific latitude and longitude, you would send an HTTP GET request to “/GetAddressFromPoint/{latitude}/{longitude}”, replacing “{latitude}” and “{longitude}” with the actual numeric values.

The method then uses these parameters to construct the URL for the Virtual Earth REST API endpoint. The latitude and longitude values are inserted into the URL, and other query parameters are added to specify the desired response format and API key.

Here’s an example of how the URL is constructed using the provided latitude and longitude parameters:

“https://dev.virtualearth.net/REST/v1/Locations/” + latitude + “,” + longitude + “?o=xml&key=”

In this example, the latitude and longitude parameters are inserted into the URL using the “+ latitude +” and “+ longitude +” syntax. The resulting URL includes the specific latitude and longitude values as part of the request to the Virtual Earth API.

The method then proceeds to perform the HTTP request to the Virtual Earth API, including the constructed URL. The response from the API is in XML format, so the method reads the response content as a string and parses it into an XML document using the XmlDocument class.

Finally, the method serializes the XML document into JSON format using JsonConvert.SerializeXmlNode and returns the JSON representation of the address information as the response to the user’s request.

In summary, the “GetAddressFromPoint” method allows users to retrieve the address information based on a specific latitude and longitude. Users can pass the latitude and longitude parameters as part of the URL when making an HTTP GET request to the method. The method constructs the URL for the Virtual Earth API using the provided parameters, retrieves the address information in XML format, converts it to JSON format, and returns it as the response to the user’s request.

You can pass below parameters in this end point.

latitude: string

longtitude: string

UploadImage:

The code snippet represents a method called “UploadImage” within a .NET Core application’s controller. This method is designed to handle an HTTP POST request made by a user to upload an image file. It accepts several parameters, which are explained below:

The method performs the following steps:

1. It tries to execute the following code block and handles any exceptions that may occur.
2. It assigns a filename for the uploaded image by checking the original filename from the files parameter. If it is null, a filename is generated based on the current date and time.
3. It determines the path where the image file will be stored based on the isSetting and isHome parameters. The path is constructed accordingly as “api.crossdeskmap.com/wwwroot/LocationIcons/” for settings, “api.crossdeskmap.com/wwwroot/CustomHomeIcons/” for home page, and “api.crossdeskmap.com/wwwroot/CustomPointerIcons/” for other cases.
4. If the image is not for a setting, it calls the UploadImage method of the pickUpPointTypeService to handle further processing of the image file.
5. It checks if the uploaded file’s length is greater than 0 to ensure it contains valid data.
6. If the target directory for storing the image does not exist, it creates the necessary directory structure using the _hostingEnvironment.WebRootPath property.
7. It creates a file path using the determined path and filename.
8. It creates a FileStream to write the uploaded file to the specified file path.
9. It copies the contents of the uploaded file to the file stream using the CopyToAsync method.
10. If the upload process is successful, it returns an “Ok” result with the uploaded filename as the response.
11. If an exception occurs during the upload process, it returns an “Ok” result with the exception details as the response.

In summary, the “UploadImage” method allows users to upload an image file through an HTTP POST request. The method processes the uploaded file, determines the storage path based on the provided parameters, and saves the file to the appropriate location. It also calls a service method for further processing, if necessary. The method handles exceptions and returns a response indicating the success or failure of the upload process.

files (type: IFormFile?): Represents the uploaded image file. It is annotated with the [FromForm] attribute, indicating that the value should be extracted from the form data in the HTTP request.

isSetting (type: bool): Specifies whether the image is being uploaded for a setting. It is used to determine the path where the image file will be stored.

isHome (type: bool): Specifies whether the image is being uploaded for the home page. It is used to determine the path where the image file will be stored.

ImageId (type: Guid?, optional): Represents an optional parameter that specifies the ID of the image. If provided, it is used during the image upload process.

RemoveImage

The method performs the following steps:

1. It tries to execute the following code block and handles any exceptions that may occur.
2. It assigns a path where the image file is stored. The path is set to “api.crossdeskmap.com/wwwroot/CustomIcons/”.
3. It checks if the image file exists at the specified path using the combination of, the determined path, and the provided imageName.
4. If the image file exists, it deletes the file using the System.IO.File.Delete method, passing the full file path as an argument.
5. If an exception occurs during the file removal process, it throws the exception.
6. If the file removal process is successful or no file exists with the specified name, it returns an “Ok” result to indicate the successful completion of the method.

imageName (type: string): Represents the name of the image file to be removed.

In summary, the “RemoveImage” method allows users to remove/delete an image file by providing the name of the file as a parameter. The method checks if the file exists at the specified path and deletes it if it is found. It handles exceptions and returns an “Ok” result to indicate the success of the operation