API overview for radi8er App endpoints

This documentation contains the specifications for the entire public-facing portion of our app's API.

  • All endpoints use https://api.radi8er.com/v1/{endpoint} {endpoint} must be substituted with the needed route
  • All endpoints with the requires authorization tag require that the user be authenticated via the /auth endpoint to be issued a token pair.

Testing

  • All endpoints use https://testapi.radi8er.com/v1/{endpoint}
  • You cannot mix Test and Production authorization tokens
GET POST DELETE PUT /{{current_doc.endpoint}} {{current_doc.description}}

Implementation Notes

Parameters requires authorization

Parameter Description Parameter Type Data Type Required
{{index}} {{parameter.parameter_type}}
{{parameter.datatype}} 

														

															
													{{(parameter.required ? 'Yes' : 'No')}}
													
												

											
										

										

											None
										

									

									

										

											Responses
										

										

										

											
												

													
														HTTP Status Code
													
													
														Reason
													
													
														Notes
													
													
														Redirect
													
												

											
											
												

													{{index}}
													
													{{response.reason}}
													
													
													
													{{response.redirect}}
													
												

											
										

										

											None
										

									

									

										

											Examples
										

										

										

											
												

													
														HTTP Status Code
													
													
														Example Response
													
												

											
											
												

													{{index}}
													
													

															
												

											
										

										

											None
										

									

								

								

								

							

						

					

						

							 radi8er © {{copy_year | amUtc | amLocal | amDateFormat: 'YYYY'}}