Getting Started with Service Objects
Service Objects has worked hard to make testing our APIs as simple as possible, and this in-depth guide to getting started will have you prepped for whenever you are ready. To get the ball rolling, simply fill out the “Free API Trial Key” form for the service you are interested in testing. This form is located on the right side of each our product pages.
If you are an Engineer/Programmer and it’s your first time signing up, you will receive an email confirming your registration. Shortly after, you will receive your Welcome email with the Trial Key and testing information. The Welcome email can be broken down into four main parts; the sample code downloads section, our detailed developer guides, sample input data downloads, and the service’s endpoint. All this information will help you get started testing quickly and smoothly.
Sample Code – We have made it our mission to provide sample code in a majority of the most widely used programming languages. This includes Ruby on Rails, Java, Python, NodeJS, C#, and many others. If your desired programming language is missing from our repository, please feel free to reach out to us. We are more than happy to provide integration advice and impart our best practices and procedures.
Within each set of sample code you will find our recommended methods of obfuscating your license key, setting request timeouts, response/error handling, and failover logic. Applying these methodologies to your code will help to ensure security and service up time.
Developer Guide – As the name implies, this is where developers (and others) can go to get into the nitty gritty of the service. This is where you can find detailed explanations for each of the inputs and outputs. The fastest way to understand the service outputs is to approach the developer guide with a clear understanding of your business logic. With your goal in mind you can make note of the various note codes, description codes, scores, and other outputs then handle the service response accordingly.
Sample Input Data – Need a data set to test with? We provide input files with records that match the operations input parameters. Running these records will result in varying service responses. These responses can be used to gain an understanding of what will be returned by the service and how the fields can be leveraged to fit your business’s needs.
Service Endpoint – The Service Objects DOTS web services allow you to make both GET and SOAP/POST requests. By clicking on the service path link in your welcome email you will be directed to the main service landing page for the particular service you signed up for. From there you can click on your preferred operation, plug in data, add your license key and click invoke. These service landing pages act as both a quick lookup tool as well as an informative page that shows the various methods of calling the service. The query string and path parameter endpoints are described on these pages. If you prefer to consume a file and have all your classes and clients auto-generated we also provide a WSDL.
Additionally, if you prefer to have us run the results for you, you can also upload your list (up to 500 records) and we will send the results back to you.
Now that you’ve read how easy it is getting started with Service Objects’ APIs, we look forward to assisting with your data needs!