The TechCare API follows REST standards. To make use of this API, your application should be capable of making HTTP requests and should accept responses in JSON format.
IMPORTANT: Local customer security policies must be in place to prevent unauthorized monitoring or eavesdropping on connections to and from this API.
For more information about the REST style, click here.
To request access, please send an email to helpdesk@naphcare.com with "API Access" in the subject line.
To make requests, you must first acquire a JWT token for authorization. To do this, make a POST request to api2.naphcare.com/api/Account/Login with the following parameters:
If your login is successful, you will receive an authentication token in the body of the response. You will need to provide this token in subsequent requests by adding the following HTTP request header:
Authorization: Bearer <your token here>To make requests to this API, use api2.naphcare.com, followed by one of the routes listed in the API Endpoints section.
For example, to retrieve a CDA for an inmate with InmateID "123", your would make a GET request to api2.naphcare.com/api/CCDA/123
Make sure to include your authentication token. See the Authorization section for details on getting and using a token.
Requests that can't be completed will result in a response with one of the following HTTP error codes:
API | Description |
---|---|
POST api/Account/Login |
Attempts to authenticate the username and password |
API | Description |
---|---|
GET api/Inmate |
Gets the list of all inmates |
GET api/Inmate/{id} |
Gets an inmate by InmateID |
API endpoints related to Inmate C-CDAs