From DocuSign, this is Developing with DocuSign. In this video, we will explore our Rooms API
via Postman. My name is Nima Poulad, a developer advocate with DocuSign.
If you're new to our platform, Postman offers a great way to explore our endpoints
and learn about them quickly. Postman is an extremely popular tool for sending REST,
SOAP, and GraphQL requests, inspect the response, and easily debug it.
DocuSign offers a custom Postman collection of preconfigured requests.
Our Rooms Postman collection is a great way to get us started with our Rooms API.
All right, let's get started.
First you need to get access to the Rooms API. The instructions to do so
are on this page. And I provided a link in the description below.
To create a Rooms account, you first need to have an eSignature developer account.
You do need to reach out to us at support-re@docusign.com
to get Rooms enabled in your developer account. In your email, please provide your account ID and
API account ID as obtained from the Apps and Keys page in your developer account settings. Lastly,
please also specify whether you need access to Rooms for Real Estate or Rooms for Mortgage.
Finally, log into your eSignature developer account from an incognito browser window.
Select your portrait at the top right of the window. Then select Switch to Rooms.
And that's it. Your Rooms account is fully set up now.
The next step is to import the Rooms collection into your Postman. Navigate
to docusign.github.io/postman-collections. And set up your environment by following
the instructions in step one. Press Set Up Your Environment.
Then fill out your integration key and the corresponding secret key
as obtained from your admin dashboard.
Then scroll down to step two and select Run in Postman under the Rooms API
to put import it to your local Postman client. The next step is to set up the
collection locally. You will need to obtain an access key before you can run any requests.
You can do so by using the Authorize Code Grant Access Token request under the Authentication
folder. When getting your authorization code, specify the following Rooms related permissions.
You will need these permissions to follow along
with the API calls I'm going to show you in this demo.
The great thing about the Rooms API is that if you're missing a specific permission
it will let you know in the error message.
Once you have your authorization code, paste it in the environment as code from URL.
Now under Requests then, you should see your access token.
The token is automatically saved and will be used in the following requests.
Next run the Get User Info request to populate some of the needed parameters, namely the base
URL. Keep in mind that the base URL for accessing Rooms API is different from the eSignature APIs.
Now go ahead and create a new room. Before you do so, you first need to create a new
role. Navigate to Role, Create a New Role. You need to add a body to this request.
The first parameter is just the name you assign to the role. It can be anything you like,
but it must be unique. The isExternal property controls whether the role is internal or not.
In this case, we want an internal role. Now run the request.
If the request succeeds, you should see a role ID
as well as more information about the role that was just created.
Grab the role ID and save it as an environmental variable as you'll need it in the next step.
Please keep in mind that we can use the following request-- Get information about
the role with the given roleId-- to get all the information that you need about any roles
in the future. All the options that you see here
are options that can be specified when you were creating a role at the first place.
Now navigate to Rooms, Create a New Room, and create your first room.
In the body of the request, put the following payload.
As you can see, this code specifies the room name, the role who is creating a room,
and some information about the physical address the room is tied to. Now lets send this request.
Now the room is created successfully.
To get information about any room that you've created, you can use the following request--
Get information about the given Room. And if you provide the roomId,
you can always get all this information from this endpoint.
List the created rooms, and you should see the room you just created.
Navigate to Rooms, Get Rooms available to the calling user.
Remove all the search parameters at the end because you want to see all the rooms.
Now run the request. You should just see the room that we just created listed in the output.
And that's it for today. Thank you for joining us today. In this video,
we showed you how you can get your Rooms account set up and how you can start setting
up requests and play around with our API using our Postman collection. Please be
sure to like and subscribe to our channel so you won't miss any future videos. Thank you.