IMPORTANT: You must have an account on our developer portal in order to connect to our API environment. If you don't currently have this access, please contact your Account Manager to complete the required paperwork and request access.
Please find below a JSON collection that can be imported into Postman to get you started with our API. This starter pack contains 3 examples - all of which are currently set up using the production URL.
EZTMS.API Start Kit.postman_collection.json
NOTE: If you are testing in the Sandbox environment, you will need to update he collection to use the Sandbox URL (https://api.sandbox.ezfacility.com/) instead of the production URL (https://api.ezfacility.com/).
Additional information on the examples included in the JSON collection:
- Get Access token
- Gets the “access_token” value needed to make all other API calls.
- Includes the “refresh_token” for OAuth2, which can be used to get a new access_token without needing the username/password again (standard Oauth2 flow)
- User must enter the following info to get this working:
- In the body, update the “username” and “password” values to your API user.
- In the “authorization” request header, you must set the Base64 encoding of the client ID + client secret combo (explained in the Swagger Documentation)
- Get information about currently authenticated user
- Gets info about the authenticated API user, including “CalendarTypeId” (sometimes referred to as LocationID)
- User must enter the Bearer “access_token” they received from step 1
- Gets information for active clients
- Gets paged information about active clients
- The “Ez-page-number” request header indicates the page number to retrieve. The Swagger documentation has more info on how paging works in the “Paging Information:” section.
- User must do the following:
- Replace “CalendarTypeId” in the URL with the “CalendarTypeId” value from step 2
- Enter the Bearer “access_token” they received from step 1 (same as you did in step 2)
Comments
0 comments