To use the RapidReg API, all requests must have an API key. You can find your API key in the integrations area when logged into your account.
You can use the following examples to build your requests.
Jump to section: Account | Brands | Items | Registrations
Account
The account endpoint is used to retrieve your basic account details.
Request
$ch = curl_init('https://rapidreg.com/api/v1/get/account');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'api' => 'your-api-key-here',
]);
$response = curl_exec($ch);
curl_close($ch);
{
success: true,
account: {
name: "Elon Musk",
mail: "[email protected]",
created: "1565202555",
access: "1600874948",
login: "1600867321",
timezone: "America/Los Angeles",
init: "[email protected]",
active: true
}
}
Brands
The brands endpoint is used to retrieve and list all of the brands you have created.
Request
$ch = curl_init('https://rapidreg.com/api/v1/get/brands');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'api' => 'your-api-key-here',
]);
$response = curl_exec($ch);
curl_close($ch);
{
success: true,
results: 1,
brands: [
{
id: "12345678-1234-abcd-efgh-1234abcd5678",
name: "Space X",
created: "1587830588",
changed: "1600872971",
subdomain: "spacex.rapidreg.com",
description: "Lets go to Mars!",
item_type: "Activity",
category: "Activity Registration",
icon: "https://cdn.rapidreg.com/brands/2020/01/spacex_logo.jpg",
active: true
},
]
}
Items
The items endpoint is used to retrieve and list all of the items you have created. Depending on the category of your brand, your items might have different names, for example... "Activity" or "Open Day", but the underlying entity is called an item.
Request
$ch = curl_init('https://rapidreg.com/api/v1/get/items');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'api' => 'your-api-key-here',
]);
$response = curl_exec($ch);
curl_close($ch);
{
success: true,
results: 1,
items: [
{
id: "123446g8-1234-abcd-efgh-123dfgdfd5678",
name: "One way trip to Mars",
created: "1587908619",
changed: "1600925683",
description: "Take a fantastic voyage through the stars and become a Martian!",
date_type: "single",
brand: "Space X",
brand_id: "12345678-1234-abcd-efgh-1234abcd5678",
active: true,
fields: {
0: {
name: "Meal Choice",
type: "dropdown",
required: true,
description: "What would you like to eat every day for the 9 month trip?",
options: {
0: "Rehyrdated Spaghetti Bolognese",
1: "Rehyrdated Pizza",
2: "Rehyrdated Ice Cream",
3: "Rehyrdated Sardines"
}
},
}
}
]
}
Registrations
The registrations endpoint is used to retrieve and list all of the registrations your customers have created.
Request
$ch = curl_init('https://rapidreg.com/api/v1/get/registrations');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'api' => 'your-api-key-here',
]);
$response = curl_exec($ch);
curl_close($ch);
{
success: true,
results: 1,
registrations: [
{
id: "3196215418332",
item_id: "ias496g8-1fgh4-abfhd-vbnm-xc3d56gr675",
brand_id: "12345678-1234-abcd-efgh-1234abcd5678",
registration: "1728132234",
duration: "0",
created: "1598107709",
field_data: {
def_name: {
label: "First Name",
type: "name",
value: "Elon"
},
def_email: {
label: "E-mail",
type: "email",
value: "[email protected]"
},
textfield_187618: {
label: "What car do you own",
type: "textfield",
value: "Model X"
},
dropdown_986327: {
label: "Favourite Holiday Destination",
type: "dropdown",
value: "Mars"
}
}
}
]
}