Introduction
The MeetingDoctors User API is a server-to-server RESTful API. JSON is used to encode all data transfer in both directions, so that everything sent to and everything received from the API gets encoded in JSON.
Authentication
To work with this API, MeetingDoctors will provide you a set of credentials for authentication, which must be added in the header of all requests.
Header | Value |
---|---|
apiKey | Integration identifier. |
secretKey | Security key only used for server-to-server communications. |
HTTP Error Codes
All the API methods (GET, POST, PUT, and DELETE) might fail with an error in the 400 range, which usually means that either the resource is not available (for example, trying to update a user that was previously deleted), or a mistake was made in the URL.
HTTP Code | Description |
---|---|
400 Bad Request | Malformed request syntax. For example, apiKey is missing. |
401 Authentication failure | For example, apiKey or secretKey are invalid. |
403 Authorization failure | The provided credentials doesn't have permissions to perform the request. |
404 Page not found | The requested resource doesn't exist |
405 Method not allowed | For example, if you are performing a POST on a resource that only allows PUT. |
406 Invalid payload | The JSON request payload was constructed improperly. |