Scribe has made it extremely easy to work with their API. Currently, in my limited free time, I am working on a reusable C# library to send and receive data from Scribe's API. Once it is completed for Version 1, I will list it to GitHub, so anyone can consume it and provide feedback on improvements. There will be a fully built out wiki with how to consume the library with references to the Scribe API documentation. Also there will be both TDD (Test Driven Development) and BDD (Behavior Driven Development) projects. This way you can see examples of how to consume the library as well as what I tested before release. If you are not familiar with BDD, I recommend you check out my blog post in my Dynamics 365 blog, that gives a high level overview of it.
Anyways, back to what this post is about. While working on the library, I came across one small issue around TLS 1.2 and making sure that the web request uses it. Luckily, this is really easy to set in C#, when using .NET 4.5. By default .NET 4.5 does not send TLS 1.2. It is supported, just not the default. So if TLS 1.2 is set for an endpoint, then we need to specify to use it. This way we decrease the chance of an error occurring. Here is a blog post I came across that helped me with my issue.
Because I am using C# .NET 4.5 I simply needed to add the following line of code:
The line of code is added right before my HttpWebRequest. Here is the fully working request method:
In this code I do use a factory to determine what kind of response I need to return. It could be just a string response or a JSON string response response. I have tested this against both Sandbox and Production API's with Scribe Online and it does work. The only other thing I want to note in the above code, is I am sending a content length of 0. This is because I did receive some error messages where content length was required, even though I wasn't sending a body. If you need to send a JSON content body, there is the method where I do that:
If you need any help on working with the Scribe Api, please feel free to leave a comment below or leave a post in the Scribe Forums. Also check out Scribe's Developer Portal for additional information.
References:
Tarnovskiy, S. (2016, April 28). TLS 1.2 and .NET Support: How to Avoid Connection Errors. Retrieved April 30, 2018, from https://blogs.perficient.com/microsoft/2016/04/tsl-1-2-and-net-support/
Anyways, back to what this post is about. While working on the library, I came across one small issue around TLS 1.2 and making sure that the web request uses it. Luckily, this is really easy to set in C#, when using .NET 4.5. By default .NET 4.5 does not send TLS 1.2. It is supported, just not the default. So if TLS 1.2 is set for an endpoint, then we need to specify to use it. This way we decrease the chance of an error occurring. Here is a blog post I came across that helped me with my issue.
Because I am using C# .NET 4.5 I simply needed to add the following line of code:
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12
The line of code is added right before my HttpWebRequest. Here is the fully working request method:
public string SendRequest(string username, string password, string url, string method)
{
WebResponseFactory factory = new WebResponseFactory();
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
request.Method = method;
request.Headers.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.UTF8.GetBytes($"{username}:{password}")));
request.ContentType = ParameterContentTypeSettings.applicationjson;
request.ContentLength = 0;
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
return factory.ProcessResponse(response);
}
In this code I do use a factory to determine what kind of response I need to return. It could be just a string response or a JSON string response response. I have tested this against both Sandbox and Production API's with Scribe Online and it does work. The only other thing I want to note in the above code, is I am sending a content length of 0. This is because I did receive some error messages where content length was required, even though I wasn't sending a body. If you need to send a JSON content body, there is the method where I do that:
public string SendRequest(string username, string password, string url, string method, string contentBody)
{
ASCIIEncoding encoding = new ASCIIEncoding();
byte[] encodedData = encoding.GetBytes(contentBody);
WebResponseFactory factory = new WebResponseFactory();
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
request.Method = method;
request.Headers.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.UTF8.GetBytes($"{username}:{password}")));
request.ContentType = ParameterContentTypeSettings.applicationjson;
request.ContentLength = encodedData.Length;
var requestStream = request.GetRequestStream();
requestStream.Write(encodedData, 0, encodedData.Length);
requestStream.Close();
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
return factory.ProcessResponse(response);
}
If you need any help on working with the Scribe Api, please feel free to leave a comment below or leave a post in the Scribe Forums. Also check out Scribe's Developer Portal for additional information.
References:
Tarnovskiy, S. (2016, April 28). TLS 1.2 and .NET Support: How to Avoid Connection Errors. Retrieved April 30, 2018, from https://blogs.perficient.com/microsoft/2016/04/tsl-1-2-and-net-support/
Nice blog post your gave for us. I heartfully thank you and i request you to add more informations like this in future.
ReplyDeleteJAVA Training in Chennai
JAVA Training in Tnagar
Selenium Training in Chennai
Digital Marketing Course in Chennai
Python Training in Chennai
Big data training in chennai
JAVA Training in Chennai
Java Training in Velachery
ReplyDeleteyour explanation way is too good, very easy to understand for all readers. Thank you for providing the best details and I want more unique posts.
Primavera Training in Chennai
Primavera Course in Chennai
Tableau Training in Chennai
Spark Training in Chennai
Power BI Training in Chennai
Excel Training in Chennai
Oracle Training in Chennai
Oracle DBA Training in Chennai
Social Media Marketing Courses in Chennai
Good explanation with appropriate solution.
ReplyDeleteArticle submission sites
Guest posting sites
Excellent post. The author has shared the post in a unique way. Have been in a wait for more updates. Do share more.
ReplyDeleteGerman Classes in Mulund
German Language Classes in Mulund
French Classes in Mulund
French Classes in Mulund East
Spoken English Classes in Chennai
Best Spoken English Classes in Chennai
English Speaking Classes in Mumbai
IELTS Coaching in Chennai
IELTS Classes in Mumbai
I feel satisfied to read your blog, you have been delivering a useful & unique information to our vision.keep blogging.
ReplyDeleteRegards,
microsoft dynamics training in chennai
Ethical Hacking Course in Chennai
PHP Training in Chennai
Web Designing Course in Chennai
microsoft dynamics crm training
gst training in chennai
microsoft dynamics crm training institutes in chennai
ccna Training in Chennai
web designing course
best weight machines
ReplyDeleteNice Article!!!
ReplyDeleteweb designing course with placement
php mysql course in chennai
magento 2 course | magento 2 training
I like the helpful info you provide in your articles. I’ll bookmark your weblog and check again here regularly. I am quite sure I will learn much new stuff right here! Good luck for the next!
ReplyDeleteGoogle ads services | Google Ads Management agency
web designing classes in chennai | Web Designing courses in Chennai | Web Designing Training and Placement | Best Institute for Web Designing
web designer courses in chennai | best institute for web designing Classes in Chennai
web designing classes in chennai | web designing training institute in chennai
mobile application development course | mobile app development training
keep up the good work. this is an Assam post. this to helpful, i have reading here all post. i am impressed. thank you. this is our digital marketing training center. This is an online certificate course
ReplyDeletedigital marketing training in bangalore / https://www.excelr.com/digital-marketing-training-in-bangalore
Thanks for sharing this valuable information to our vision. You have posted a worthy blog keep sharing.
ReplyDeleteDigital Marketing Course In Kolkata
Web Design Course In Kolkata
SEO Course In Kolkata
Just the way I have expected. Your website really is interesting
ReplyDeleteDigital Marketing Training Course in Chennai | Digital Marketing Training Course in Anna Nagar | Digital Marketing Training Course in OMR | Digital Marketing Training Course in Porur | Digital Marketing Training Course in Tambaram | Digital Marketing Training Course in Velachery
I have been reading for the past two days about your blogs and topics, still on fetching! Wondering about your words on each line was massively effective.keep it up
ReplyDeleteAi & Artificial Intelligence Course in Chennai
PHP Training in Chennai
Ethical Hacking Course in Chennai Blue Prism Training in Chennai
UiPath Training in Chennai
The content that I normally go through nowadays is not at all in parallel to what you have written. It has concurrently raised many questions that most readers have not yet considered.
ReplyDeleteSAP training in Kolkata
SAP training Kolkata
Best SAP training in Kolkata
SAP course in Kolkata
The content is well recognized, so no one could claim that it is just one person's opinion yet it covers and justifies all the valid points. Hope to read some more work from you.
ReplyDeleteData Science training in Mumbai
Data Science course in Mumbai
SAP training in Mumbai
Excellent blog thanks for sharing the valuable information..it becomes easy to read and easily understand the information.
ReplyDeleteUseful article which was very helpful. also interesting and contains good information.
to know about python training course , use the below link.
Python Training in chennai
Python Course in chennai
I believe there are many more pleasurable opportunities ahead for individuals that looked at your site.
ReplyDeleteCRM Software