10 - API Settings

An explanation of API settings and how to modify them. [07:41]

Transcript

  1. In an earlier video, we talked about some of the request settings that you can make as part of your API request, some of the parameters, things like certainty and priority. You can also modify those settings at the account level.
  2. In other words, you can modify it in such a way that all of your testing after that already has those settings made. The way you do that is to log in and then go to this link here that says API settings.
  3. Under API settings, this will customize the way that Tenon tests for all of your tests. You can override this at any time. You can override this at the project level or you can override this at the specific test level. This is a great way to set your own default settings for Tenon.
  4. Let's go through this. Default certainty again, we talked about this in the previous video. In this case, certainty is what the minimum certainty you want on your test. Remember I said that each test has its own certainty score. You can set this so that you don't get results for anything below that minimum certainty. I'm going to set this to 80.
  5. In a practical scenario, what I would recommend doing is leaving this as low as you can, except for instances where you're using it as part of something like continuous integration or something like that. I'm going to leave this at 80 for now.
  6. Default priority is, again like I had mentioned before, the prioritization score for the results. In practical instances, I would never go below 60 on this because there are going to be some things that are important.
  7. They're going to land here during prioritization scoring between 60 and 80, that we should probably pay attention to. 100 is way too stringent in my opinion, but we let you have it, so there you go.
  8. Next step is default fragment. What we're saying here is if you're only sending over source, set this to yes. Probably 99 percent of the times you're going to want to [inaudible 03:00] this to no.
  9. Importance is discussed at length in the documentation, but basically the importance goes towards calculating the priority. At this point when you're setting your own global defaults, I'd set that to zero. You can override this at the project level or the test round level. On a practical basis, I'd leave it to zero.
  10. Default level has to do with the WCAG level. The level A double layer, triple A items under WCAG. By default it's going to be set to triple A. You can change that to whatever you want.
  11. You can change it to A, double A or triple A. I linked this to triple A because I find that certainty and priority are more useful. There are some WCAG triple A guidelines that are important.
  12. Reference info, this is has to do with your API calls themselves and whether or not you want a reference link as part of your results. In a previous video, we showed how I have that recommended fix link in the test results as part of your API responses.
  13. You can turn that on or off. Basically, you would turn it off if you really felt that the amount of data being transferred back and forth was a big deal. It usually isn't, so I'd leave it on.
  14. Next up is store results, whether you want Tenon to store results or not. Some people want to use the API only. They don't want to store results either for privacy or security concerns. You could say yes or no on this.
  15. Keep in mind that in that earlier video where I looked back at the history and saw that View Results. If we say no to this, we won't get that link and we won't be able to see those results. All we would see are issue counts.
  16. Finally some text fields, default user read in string is the user read in string identified by Tenon or more accurately by Tenon's head list browser that it uses. This is not something that has any impact on testing. Some people may want to customize this as a way of white listing Tenon for accessing a test environment.
  17. We don't do anything magical. We don't change to a different rendering engine based on this. It really is just a string of text. You could put anything you want in here.
  18. Next up is viewport width and viewport height. Viewport height is not really as important as viewport width is. We provide these so that you can actually dictate the size of the viewport for Tenon's test engine. Why this is really cool is because you can use this to test responsive designs.
  19. You probably don't want to set this at this level right now because remember, this is API settings for your entire account. It's probably more appropriate for you to set these in the project.
  20. We do set a 1024x768 for our viewport height and viewport width because some users with low vision will use this type of resolution to make it easier to see the screen.
  21. Finally, default delay takes a numeric string for how long Tenon should wait before it triggers testing. Default delay right now is unset. If you happen to know that you need to wait for other assets to load. JavaScript files or CSS files that get delivered from a CDN or that you know that your page takes a long time to render, you can change that value.
  22. If I was to say 1,000 here, that would be one second. There would be 1,000 milliseconds. Tenon will not execute its testing until that one second has elapsed. I'm going to remove that.
  23. Now I have saved my API settings. All of my testing will adhere to these settings unless I override them at either the project level or the test round level. That is editing your API settings.