partners-api-docs.myresman.com

the resman partner api will provide you access to any of the data and functionality you will need to build out your product. the following guides and documentation will provide you everything you need to get started. ## **getting started guide** to start using the resman partner api, please take note of the following items: - you must apply to become an integration partner with resman before you gain access to any apis. to apply, please submit your application [here](https://go.myresman.com/partner-with-resman). - each api request requires an integration partner id and api key - each api request requires you submit a header value of ressman-account-id identifying the client's account you are wanting to access. - the api only responds to https-secured communications. - the api returns request responses in json and xml format based upon the submitted accept header ## authentication the resman partner api uses basic authentication to ensure requests are permitted. you must include your issued integration partner id and api key with every request in order to access the api. ### authentication error response if an api key is missing, malformed, or invalid, you will receive an http 401 unauthorized response code. ## converting from version 1 if you are converting from version 1 of the api to this new version, take into account a few changes that will be universal for all methods. - each end point will require the appropriate http method instead of all requests being made as get requests - every request will require a resman-account-id header populated with the client's associated accountid - all get requests will provide parameter values in the query string - all post and patch requests will provide parameter values in the body of the request all of the methods from version 1 will be ported over to version 2 with similar or identical requests and responses. but, the organization of version 2 has changed. the followin