Robert Axle Project FitFinder API v1

Overview

Welcome to the Robert Axle Project FitFinder API documentation. The FitFinder API is a powerful tool designed to help you seamlessly integrate bicycle fitment finder functionality into your applications. FitFinder API specializes in identifying suitable Robert Axle thru axles for a vast array of bike models and configurations.

Base URL

The API is hosted with Amazon Web Services and available at:

https://f6nnnrptej.execute-api.us-west-2.amazonaws.com/API

Authentication

To access the FitFinder API, a client ID is required. The client ID serves as your application's unique identifier and API key. To obtain a client ID, please get in touch with [email protected].

Testing Authentication

You can make a test request using the provided client ID to verify that your client and authentication are working correctly. For example:

GET [BASE_URL]/client-class?client_id=YOUR_CLIENT_ID

Replace YOUR_CLIENT_ID with the client ID assigned to your application. A true response from the API indicates that your account is active.

Select-Options-Client Endpoint

The select-options-client endpoint facilitates the sequential input of customizable options for the Thru Axle Fit Finder, guiding users through the selection process for optimal bike fit. This sequential input accepts and returns values for "attachment," "type," "ebike," "brand," "hub," and "model." The endpoint is meticulously designed to provide responses tailored to individual clients' unique specifications and preferences at each stage of the fit finder.

POST [BASE_URL]/API/select-options-client

Request Data

The select-options-client endpoint requires data in the form of a JSON object containing the current_selections parameter. The parameter uses a specific delimiter system for sequential input. Here's an example of how you should structure the request data:

{"current_selections":"YOUR_CLIENT_ID_|_attachment___type___ebike___brand___hub___model"}:

Trim all whitespace from posting values. E.g. 'Front Rack' -> 'FrontRack'
Prepend the value string with your client ID followed by an underscore, pipe, and underscore. E.G. 12345_|_
For each category (e.g., "attachment," "type," etc.), use three underscores (___) to separate the choices.

Here's a complete example of a full SKU request:

{"current_selections":"1234_|_FrontRack___RigidFork___No___AllCity___12x100___SuperProfessional"}:

Order, Selections, and Definitions

Order	Selection	Definition
1	Client ID	Unique identifier assigned to your application by the API.
2	Attachment	What users want to attach to the bike (e.g., Kid Trailer, Front Rack, Training).
3	Type	The type of bike component (e.g., Rigid Fork, Suspension Fork).
4	Ebike	Indicates whether the bike is an electric bike (Yes/No).
5	Brand	The brand of the bike (e.g., All City, Trek).
6	Hub	The hub specification of the bike (e.g., 12x100).
7	Model	The model of the bike (e.g., Super Professional).

Building a Fit Finder (Request -> Response)

Step 1: Client ID -> Attachment

The first step is to send the client ID to the API endpoint to retrieve your available attachments. Follow the steps below:

Request: Make a POST request to the select-options-client endpoint:

POST [BASE_URL]/select-options-client

Request Body: Include the client ID in the request body using JSON format:

{"current_selections": "YOUR_CLIENT_ID"}

Replace YOUR_CLIENT_ID with the actual client ID assigned to your application.

Example using cURL: curl -X POST [BASE_URL]/select-options-client -H 'Content-Type: application/json' -d '{"current_selections":"YOUR_CLIENT_ID"}'

Response: The API will respond with available attachment options based on the provided client ID. The response will contain an array of available attachment choices.

Example Response: "['Front Rack', 'Rear Rack','Kid Trailer']"

Now, you have obtained the available attachments for the specified client. Proceed to the next steps based on user selections.

Step 2: Attachment -> Type

Once step 1 is complete and an attachment is chosen, you can make a POST request for the type of bike.

Request:
Make a POST request to the select-options-client endpoint:

POST [BASE_URL]/select-options-client

Request Body:
Include the client ID and chosen attachment in the request body using JSON format. Ensure that whitespaces are trimmed. For example:

{"current_selections":"YOUR_CLIENT_ID_|_KidTrailer"}

Replace YOUR_CLIENT_ID with the actual client ID assigned to your application.

Example using cURL:
curl -X POST [BASE_URL]/select-options-client -H 'Content-Type: application/json' -d '{"current_selections":"YOUR_CLIENT_ID_|_KidTrailer"}'

Response:
The API will respond with available types based on the chosen attachment. The response will contain an array of the available choices for the next stage.

Example Response:
"'Road Bike', 'Gravel/Cross Bike', 'Mountain Bike', 'City/Commuter Bike', 'Recumbent', 'Fat Bike'"

Now, you have obtained the available types for the specified attachment. Proceed to the next steps based on user selections.

Step 3: Type -> Ebike

Once step 2 is complete and a type is chosen, you can make a POST request for the Ebike decider.

Request:
Make a POST request to the select-options-client endpoint:

POST [BASE_URL]/select-options-client

Request Body:
Include the client ID, attachment, and type in the request body using JSON format. Ensure that whitespaces are trimmed. For example:

{"current_selections":"YOUR_CLIENT_ID_|_KidTrailer___MountainBike"}

Replace YOUR_CLIENT_ID with the actual client ID assigned to your application. Note the value string delimiter is three underscores (___).

Example using cURL:
curl -X POST [BASE_URL]/select-options-client -H 'Content-Type: application/json' -d '{"current_selections":"YOUR_CLIENT_ID_|_KidTrailer___MountainBike"}'

Response:
The API will respond with a boolean array for ebike (Yes/No).

Example Response:
"'Yes', 'No'"

Now, you have obtained the ebike options for the specific client. Proceed to the next steps based on user selection.

Step 4: Ebike -> Brand

Once step 3 is complete and a Ebike yes/no is chosen, you can make a POST request for bicycle brands.

Request:
Make a POST request to the select-options-client endpoint:

POST [BASE_URL]/select-options-client

Request Body:
Using JSON format, include the client ID, chosen attachment, type, and ebike yes/no in the request body. Ensure that whitespaces are trimmed. For example:

{"current_selections":"YOUR_CLIENT_ID_|_KidTrailer___MountainBike___Yes"}

Replace YOUR_CLIENT_ID with the actual client ID assigned to your application. Note the value string delimiter is three underscores (___).

Example using cURL:
curl -X POST [BASE_URL]/select-options-client -H 'Content-Type: application/json' -d '{"current_selections":"YOUR_CLIENT_ID_|_KidTrailer___MountainBike___Yes"}'

Response:
The API will respond with a boolean array for ebike (Yes/No).

Example Response:
"'Panorama', 'Wilier', 'Felt'"

Now, you have obtained the brand options for the specific client. Proceed to the next steps based on user selection.

Step 5: Brand ->Hub

Once step 4 is complete and a brand is chosen, you can make a POST request for hub sizes.

Request:
Make a POST request to the select-options-client endpoint:

POST [BASE_URL]/select-options-client

Request Body:
Using JSON format, include the client ID, chosen attachment, type, ebike yes/no, and brand in the request body. Ensure that whitespaces are trimmed. For example:

{"current_selections":"YOUR_CLIENT_ID_|_KidTrailer___MountainBike___Yes___Kona"}

Replace YOUR_CLIENT_ID with the actual client ID assigned to your application. Note the value string delimiter is three underscores (___).

Example using cURL:
curl -X POST [BASE_URL]/select-options-client -H 'Content-Type: application/json' -d '{"current_selections":"YOUR_CLIENT_ID_|_KidTrailer___MountainBike___Yes___Kona"}'

Response:
The API will respond with an array of hub sizes.

Example Response:
"'12x148 (BOOST)', '5mm QR SKEWER', '12x157'"

Now, you have obtained the hub options for the specific client. Proceed to the next steps based on user selection.

Step 6: Hub -> Model

Once step 5 is complete and a brand is chosen, you can make a POST request for model.

Request:
Make a POST request to the select-options-client endpoint:

POST [BASE_URL]/select-options-client

Request Body:
Using JSON format, include the client ID, chosen attachment, type, ebike yes/no, brand, and hub in the request body. Ensure that whitespaces are trimmed. For example:

{"current_selections":"1012_|_KidTrailer___MountainBike___Yes___Kona___12x148(BOOST)"}

Replace YOUR_CLIENT_ID with the actual client ID assigned to your application. Note the value string delimiter is three underscores (___).

Example using cURL:
curl -X POST [BASE_URL]/select-options-client -H 'Content-Type: application/json' -d '{"current_selections":"YOUR_CLIENT_ID_|_KidTrailer___MountainBike___Yes___Kona___12x148(BOOST)"}'

Response:
The API will respond with an array of models.

Example Response:
"'Remote HARDTAIL', 'Remote 130'"

Now, you have obtained the model options for the specific client. Proceed to the next steps based on user selection.

Step 7: Model -> SKU

Once step 6 is complete and a brand is chosen, you can make a final POST request for the Robert Axle Project SKU.

Request:
Make a POST request to the select-options-client endpoint:

POST [BASE_URL]/select-options-client

Request Body:
Using JSON format, include the client ID, chosen attachment, type, ebike yes/no, brand, hub, and model in the request body. Ensure that whitespaces are trimmed. For example:

{"current_selections":"1012_|_KidTrailer___MountainBike___Yes___Kona___12x148(BOOST)___Remote130"}

Replace YOUR_CLIENT_ID with the actual client ID assigned to your application. Note the value string delimiter is three underscores (___).

Response:
The API will respond with a SKU number.

Example Response:
"'KID211'"

Congratulations, you have found the SKU!