August 14, 2018

APIs

Vedlogic has mastered the skills required for developing APIs, solutions built around APIs and integrations with Third-Party APIs.

We have resolved issues faced by clients, who had heterogeneous platforms consisting of many applications without proper integrations between them. We iron out these issues by introducing and developing APIs for them to cut down a lot of overhead to client businesses. Clients benefit from reduced complexities, safe and secure, centralised library of business components in the form of APIs. They act as a fully reusable component and are easy to manage during integration between systems.

Challenges & Approach

Are your APIs scalable?
When you publish API either limited to enterprise purpose or for public, many applications and consumers are going to use it. If the service cannot handle multiple concurrent requests then the entire purpose of developing and publishing APIs get defeated. To avoid such situations, the APIs should be designed and developed with keeping high scalability as a basic requirement. Vedlogic has the expertise to design and develop highly scalable APIs with 99.9% up time with high performance.
Do you know APIs have best practices for naming conventions?
For easy and successful usage of APIs, it is very important to follow the best practices in naming API methods and parameters. Organisations miss out on this and it leads to a lot of mess and confusions for Third Party Integrators on what is the purpose of each API methods and what each of its parameters mean. We strongly follow the best practices and apply proper thought in naming to our APIs. It has helped clients achieve easy and quick integrations with very less or no support required.
Do you know APIs can have asynchronous process in background and still return faster response (staged responses)?
For APIs, quickest response is a key. If you adopt same approach for all kind of API methods, sometimes the heavy data/actions processing APIs can block your connections for longer duration and APIs become unresponsive. We have solved such problems for many clients and we apply innovative approaches to keep API responses faster and serve the purpose of Integrators. A key example of such best practice we follow is to introduce staged response by splitting one response in to multiple request/responses.
Are your APIs addressing best filtration and pagination needs?
Sending a bulk of data is time and bandwidth consuming approach. Instead, best approach is to send filtered and paged data for better performance. It is in the blood of every Vedlogician to expose data with best filtration criteria and pagination and we do consultation, development and train teams to better implement such good practices.
Do you know partial responses are widely used for binary type large data?
Nobody has a time to wait for response in fast moving world and it is a mandatory kind of requirement to deliver contents in chunks when the size of data is very large. This asynchronous sending the partial responses makes better user experience particularly for binary large objects (BLOB). Vedlogic’s innovative approach makes such things possible.
Do you know API versioning is a mixture of an art and science?
Once API is published and other applications or users start using it then any change in API needs to be addresses very carefully, otherwise, it can impact integration partners badly. It is really an art and science and we do have world-class designer and developer who are born scientist and artist to deliver better result for API versioning. We have worked with simple to complex API solutions & API Suites and well versed with developing API solutions that run smoothly and not impacted with ongoing changes/releases being made.
Are your APIs effectively managing response codes?
Bad API responses ignore to send response code while sending back data or error messages. It is a good practice to send response code with data or error message to consumer for every request. Response Codes and Error Messages need to be very meaningful and they should be broken down to the specific errors rather than general error codes. There is no cost involved in sending the response codes and Team Vedlogic always takes care of such generally ignored areas.
Are your APIs most secure (beyond SSL and credentials)?
Sensitive information needs to be protected behind secured credentials and if it requires to be transmitted over the network then it should be transferred using unbreakable encryption algorithms. APIs are no exception. APIs also transmits sensitive data to consumer. We take care of such requirements and implement APIs with unbreakable encryptions/hashing to the data level for sensitive data. With this even if someone is able to intercept the data, they cannot do any damage with it.
Do you consider documentation equally important as developing APIs?
One of the basic requirement for ease of use it enough details should be available to consumers of API, that is documentation. Continuous evolution of the API also require better synchronised documentation and better tools take care of it. We use different tools like Swagger, RAML and Atlasian Confluence to automate the documentation of APIs. In addition to API methods documentation, we also consider documenting the API Integration process so that it becomes seamless process for any integration partner.
Are your APIs developer friendly as they are ultimate users?
Organisations implement APIs and throw to Integration partners to be on their own. The approach is right, but if APIs are not developed to be developer friendly or not properly documented, it brings major struggles for Developers of the Integrating partner. We always develop the APIs that have meaningful names, meaningful implementation flow that is easy to understand and implement for third-party integrators. When we say that are our API integration is as simple as “Do It Yourself”, we really mean it.
Do you struggle between custom Authentication v/s OAuth 2?
When custom authentication is used, user has to remember one more username and password to access it. OAuth is an open standard or protocol which provides facility to user by service provider with the collaboration of tech giants like Google, Twitter, Facebook and many more. Using an OAuth 2 standard is one of the feature provided by our APIs. We have experience with all different standards for API development and we help our clients by implementing/advising with right approach.
Do your APIs effectively use caching of information?
Effective use of caching plays a very important role in faster performance of APIs. However, there are pros and cons of using caching heavily. We have extensive knowledge and experience around API architecture with using caching in an optimum way. We have also experience with various industry leading tools that manage caching very effectively.
You want to integrate with third-party API provider, but you don’t have your own development team?
A major problem many small organisations face that they never have their own Technical Development teams. They always hire third-party vendors for their web system design and development for one off development contract. After the work is over, they realise that they want to integrate with third-party APIs for getting right benefits for business functions. But, they then lack skills to integrate APIs within their own platform. For such clients, we come as a saviour. We have worked with many such clients to implement API integrations and then do a maintenance contract for any ongoing changes they may need to do. This model has helped such small clients very well and it keeps their costs low and they get equal attention for implementation needs when required.
You offer API Suite to your clients. But what if you do not have your own Support team to help onboarding clients for integration?
Many organisations implement their own API suites to offer wide range of system functions. They are then able to attract good pool of their clients who will go for Integration with them. However, the trouble starts when the new clients require lot of ongoing support from API provider organisation. However, providing functional/technical support to integration clients eats up a lot of time and this causes distraction to the API provider organisation from doing their day-to-day activities. We come into the picture for such API Provider Organisations. We become their Technical Support Partner. We learn their APIs and from then on for any new client onboarding, the support requests is taken care of by our team. This has helped a lot of clients remove the burden from their support team.