VigLink offers many different APIs you can use to uncover more detail or help power your project. But let’s say you want to see the type of information it gives you; and if the data is what you’re looking for, how it would look, or even, how to use it before deciding if it’s the API you will use.
Luckily, we have a “Try it Out” section that requires zero coding at all -- just some information that can be found in your VigLink account settings. With most of our API Documentations, there will be a “Try it Out” section located at the very bottom of the page. In these sections, you can test to see exactly what information will be provided, the different filters or parameters that you can use, and of course, the results itself.
Here’s a link to our API Documentations: https://viglink-developer-center.readme.io/docs
Before diving in, let’s find out where you can locate the two kinds of information that is crucial to “Test it Out”. The two kinds of information needed is API Key and Secret Key.
The path to this information is Account > Sites > your domain name > “key” icon under Actions.
**Please do not share your Secret Key**
Now that you have found your secret, let’s take a look at our new Transaction Report API documentation: https://viglink-developer-center.readme.io/docs/transaction-reporting
Scroll to the bottom of the page and you’ll see:
- This is the area where you’ll be placing your Secret Key. Click on the green key icon and a field will appear for you to type in your Secret Key. The format of how this should be typed is the word “secret”(without quotations), then a space, and then your Secret key. So, it should look something like this:
- In order to run this “Try it Out”, you’ll need the minimum of these two fields, which is what the red asterisks are denoting. The date format should be YYYY/MM/DD.
Press “Try it” below all the field boxes and that’s it! You should see your results in a window:
Now that you have the basics, you’ve might’ve noticed the other boxes with fields you can fill in. These are the different parameters you can use to be more specific with the data being returned. These parameters are outlined at the top of API documentation to let you know what type of information it is.
Using the same Transaction API with the same dates, try searching for a “merchantName”. *Quick tip* the format and punctuation have to be exactly what we have in our system. So we recommend running a basic call like we did above to familiarize yourself with the format the results are in. For example, if we want to filter down by Walmart, we’ll have to type it in the field exactly how we saw it in the report:
Press “Try It” and it will only return results with the merchant name “Walmart”.
This strategy will work for the other parameters in this Transaction API or another API you decide to “Try it Out”. Using the results from the initial data return, you can learn what the field is looking for and how to fill it in to narrow down your dataset to get exactly what you’re looking for.