top of page

Technical Writing Sample

This is a technical writing sample I've created to display my general knowledge of APIs and programming, as well as my proficiency at writing technical documentation. 

Quickstart Guide: How to use the Sweat API 
with C# and .NET Framework

What is the Sweat API?

Sweat is a class management developer platform designed with your small business in mind. The Sweat API is a suite of libraries and REST API calls designed to allow you to easily manage user profiles, class attendance, payment processing and other essential business needs.

Who is the Sweat API for?

The Sweat API can take away much of the pain and troubleshooting that comes with managing users for class-based business, including small gyms, fitness centers and dance studios.

Sweat also works seamlessly with Squarespace, Wix and other web creation tools, making it easy to add to an existing website or app.

Read more about adding Sweat to your Squarespace website here.

Through this quickstart guide, you’ll learn how to:

  1. Set up a .NET development environment to access Sweat user data

  2. Create new Sweat user profiles

  3. Enroll users into new classes and programs

First things first, sign up for a free Sweat business account

Already have a Sweat account? Feel free to move on to the next step.

Visit SweatApp.com/createaccount to sign up for a free business account.

Once your account is created, you will receive a message at the email address provided during account creation. This email contains your username and password, which you’ll need in the next few steps.

Next, let’s install Visual Studio

Download and install Visual Studio 2019 here.

Once installation is complete, open Visual Studio and create a new Command line project:

On the Visual Studio startup page, click on the New button.

Screenshot 2024-01-18 at 3.37.38 PM.png

Next, select .NET from the side bar and click on console project. Then, click next.

Screenshot 2024-01-18 at 3.38.29 PM.png

Finally, give your project a project and solution name. Then click create on the bottom right.

Screenshot 2024-01-18 at 4.05.55 PM.png

Now, let’s create our first user

Now that we have our .NET project up and running, we can start creating users and sign them up for classes under your business.

Open the Program.cs file and paste in the following code snippet:

Screenshot 2024-01-19 at 12.27.45 AM.png

Make sure to replace the values for “accountId” and “authToken” with your own credentials. These values can be found in your welcome email or in your account at SweatApp.com/AccountInformation.

Next, replace the “newUserID” and “newUserPassword” placeholder values with new user credentials. You can find test inputs for these values used for learning the API at SweatApp.com/AccountInformation/TestUser.

The code snippet above demonstrates how to create a Sweat Client, the entry way into the Sweat API. We used this object to create a new user object, which represents a potential user for your business.

Finally, Lets add a user to a new class

Now that we’ve created a Sweat client object, we can use it to create additional objects to represent your business and the classes your business will offer.

In Program.cs, paste the following code snippet below the earlier one:

Screenshot 2024-01-19 at 12.49.31 AM.png

Next, replace the “businessId” and “className” placeholder values with new user credentials. Once again, you can find test inputs for these values used for learning the API at SweatApp.com/AccountInformation/TestUser.

In the above snippet, we’ve generated a business object to represent your business. Using this business object, we called the function “enrollUser” to enroll the previously created user into the business.

Next, we created a class object to represent a class that you business will offer and added the user to this class. This class object will now have a record of all users added to it.

Now, you can save your changes and run the project by hitting the play button at the top left corner of the Visual Studio. After running this code, If you open you account information at SweatApp.com/AccountInformation, you can see the changes you just made to your business account.

You did it!

What's Next

In this tutorial you’ve learned the basics of creating creating users and classes for your business using the .NET framework. If you want to learn how to do this using other code platforms, or if you want to learn more about other functions of the Sweat API, check out the resources below:

  • Full REST API Documentation

  • How to use Sweat with a Squarespace site

  • Quickstart Guide: How to use the Sweat API with Javascript and React

bottom of page