📍
Bolt Help / Technical Writing Assessment
Technical Writing Assessment - APIs
APIs are essential to merchants who integrate with Bolt using custom development. For this exercise, pretend that you’re working with an engineer on your team who has put in a request to update API documentation for the Bolt API Account endpoint.
Take a moment to familiarize yourself with this information and then we’ll talk through a few questions. Feel free to search the help site or broadly on the internet as needed while answering.
The engineer sends over the following information:
- New Endpoint: [POST] /v1/account
- Description: Create a Bolt shopping account.
- Payload:
{
"profile": {
"first_name": "Alan",
"last_name": "Watts",
"email": "alan.watts@bolt.com",
"phone": "1-867-5309"
},
"addresses": [
{
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": null,
"street_address4": null,
"locality": "Brooklyn",
"region_code": "NY",
"region": "NY",
"postal_code": "10044",
"country_code": "US",
"country": "United States",
"name": "Alan Watts",
"first_name": "Alan",
"last_name": "Watts",
"company": "Bolt",
"phone": "1-867-5309",
"email": "alan.watts@bolt.com",
"default": true
}
],
"payment_methods": [
{
"token": "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0",
"last4": "1234",
"bin": "string",
"number": "string",
"expiration": "12/12/2024",
"postal_code": "10044",
"billing_address_id": null,
"billing_address": {
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": null,
"street_address4": null,
"locality": "Brooklyn",
"region_code": "NY",
"region": "NY",
"postal_code": "10044",
"country_code": "US",
"country": "United States",
"name": "Alan Watts",
"first_name": "Alan",
"last_name": "Watts",
"company": "Bolt",
"phone": "1-867-5309",
"email": "alan.watts@bolt.com",
"default": true
},
"save": true,
"token_type": "bolt",
"network": "unknown",
"cryptogram": "string",
"eci": "string",
"default": true
}
]
}
Questions
- What information is contained in the profile object?
- What is the name of the user Bolt is creating this account for?
- What is the user’s address?
- If a user created their account incorrectly (with the wrong address), using the API, how would you fix it?
- Based on the information presented here, what questions do you have?
- What information is missing?
- How would you find the answers you need?
- Which other documents would you estimate that you need to create?