API Setup and Documentation
The Wisr API allows programmatic access to data stored on the Wisr Platform. It is built on REST principles and has resource-oriented URLs that use appropriate HTTP methods and response codes. Using an authentication bearer token, a member is able to easily send HTTP requests to retrieve data and in some cases modify data.
- Request API access from the Wisr Team by clicking the contact button on this page and submitting a request (we will create an admin account in the API Testing environment).
- Log in to your admin account at https://api-sandbox.wisr-staging.com with your username and password.
- Retrieve your API Token by going to the following URL and observing the key field: https://api-sandbox.wisr-staging.com/api/v1/me/authtoken
- Optional: Save your token in a secure way (we recommend using a password vault application like 1Password).
- Include your token in an Authentication header on each request to the API. No username or password is needed. Example -- Authorization: Bearer d33bc008cadefdfe15f514fe3df55bf0c82f039f
Regenerating Your Token
We recommend using a HTTP client tool like Postman to test with. Postman is free and has built in tools to quickly and easily explore an API. A preview of testing the Wisr API with Postman is as follows:
When a paginated request is made (i.e., there are more records available than how many were returned in the request), the Wisr API will automatically include a couple headers for your convenience.
The X-Total-Count header provides the total number of records in the result set.
Link <https://api-sandbox.wisr-staging.com/api/v1/profiles?page=1>; rel="first", <https://api-sandbox.wisr-staging.com/api/v1/profiles?page=2>; rel="next", <https://api-sandbox.wisr-staging.com/api/v1/profiles?page=2>; rel="last"<br>
Requests per minute: 30
Requests per day: 2,000
- Increase the page_size to 100 to reduce the overall number of requests
- Add a sleep of 2 seconds in your loop so that your script is executing a request every 2 seconds, which would stay under the 30/min burst limit