SensediaSensediaSensediaSensedia
  • API Products
    • API Management Platform
    • API Governance
    • Event-Driven Architecture
    • Service Mesh & Microservices Architecture
    • PCI
    • Flexible Actions
  • API Services
    • Consulting & Professional Services
    • Developer Experience
    • API Care
  • Solutions
    • Insurance
    • Open Banking
    • Retail & E-commerce
  • Blog
  • Contact
    • Contact
    • Customers
  • Career
  • English
    • Portuguese (Brazil)
    • Spanish

How to guarantee a successful consumption of APIs?

    Home Uncategorized How to guarantee a successful consumption of APIs?
    10 dias de como aumentar o consumo das apis

    How to guarantee a successful consumption of APIs?

    By Luciana Bandeira | Uncategorized | 0 comment | 15 September, 2020 | 0

    Many actions, which at times may even seem trivial, can be performed to help the developer who is implementing the consumption of APIs to use it correctly, thus avoiding an overload of unnecessary and incorrect calls in addition to not understanding the flows and actions.

    Below we will list 10 steps that can assist in the process of ensuring the consumption of APIs and thus their use in an optimized and successful way.

    10 steps to ensure successful consumption of APIs

    1. Extracting metrics

    Extracting usage metrics from the executed requests will let you know exactly the usage volume and what is the percentage of Errors X Successes, in addition to identifying major issues of APPs/developer, operation and type of error, and, consequently, implementing actions to improve the experience and usage.

    1. Constant error alignment

    Providing feedback to the developer, with evidences and guidelines for adjustments, will enable aligning the error scenarios, and supplying information to fix the issues. Assuming that your developer makes errors due to some process failure, it is possible to align as soon as possible according to the evidences and guidelines for fixing the errors internally in the development process.

    1. Monitor executed error calls

    In addition to extracting and identifying errors when using APIs, it is also important to conduct constant monitoring. So, it will be an effective action to identify the cause/reason for such errors and also check out if the developer has made the necessary fixes. This action also will assist in item 2, where it will be possible to collect the evidence for alignment with the developer and monitor usability.

    1. Developer Portal with documentation and inputs about the API

    The Developer Portal is the entry for the developer who wants to consume the available APIs and it must be through it that the information and user guides are available.

    1. Clear and elaborate documentation on the Developer Portal

    This will support the entire onboarding process and make understanding clearer. An easy-to-communicate Dev Portal is one that contains both technical and business language, for a wider range of information.

    1. Inclusion of best practices in the Dev Portal about the use of the API, business rules, possible HTTP Status

    Some of the information that we believe is necessary to include in the Dev Portal, as it will support the developer in understanding the rules more objectively, and thus being able to include rules and information in the development itself.

    1. Return message with clear and explanatory error information

    This will make it easier for the developer to understand when an error occurs. Exposing a friendly message when an error occurs, in addition to standardizing HTTP Status, will assist the developer to more easily identify errors and causes.

    1. Development of recognition of returns on the developer side

    For example, the developer needs to identify the error through the http status + error message displayed, and take the necessary actions, thus avoiding continuation of the scenario repeatedly.

    1. Swagger with quality

    A very detailed swagger with the description of the fields, example of values and all the query params will help the developers and reduce the usage “discovery” time.

    1. Test environment

    For simulating the processes that will be executed/used in production. Thus, the developer will be able to carry out the necessary tests and several simulations, without impacting use in the production environment.

    These are some points to be aware of in terms of the experience that developers are having when consuming your APIs, whether they are open or private.

    Here at Sensedia, we have multiple resources that can help you be more successful with the distribution and onboarding strategies in the APIs to ensure that best practices are being applied properly.

    No tags.
    Luciana Bandeira

    Luciana Bandeira

    More posts by Luciana Bandeira

    Related Post

    • Aumento sazonal na prática

      Capillary action: how e-commerces thrive

      By Lucas Tempestini | 0 comment

      To make your business grow, it’s necessary to reach as many prospective new clients as possible, besides developing customer loyalty from previous clients. For that, investing in creating capillarity has a fundamental function. Amazing! But,Read more

    • What REALLY is Omnichannel?

      By Lucas Tempestini | 0 comment

      Omnichannel, multi-channel, crosschannel… I bet that you have already found these terms sometimes when searching on the Internet. You have even read some things about omnichannel, maybe you already know what it is. But doRead more

    • Health Insurance market with wearable technology

      By Eduardo Arantes | 0 comment

      Soccer with friends on Saturday… The first 10 minutes go well, you run through the sides, throw deep passes, and even score a goal in a rebound from a shot. And from the eleventh minute on?Read more

    • lo que CIOs necesitan saber sobre APIs

      What CIOs must know about APIs

      By Lucas Tempestini | 0 comment

      We’ve already written multiple articles here in the Blog about how APIs are part of our daily routine, from login on websites through our social network profiles, to the color of your house’s lamps dependingRead more

    • Sensedia ready to go International

      By Lucas Tempestini | 0 comment

      Sensedia, a Brazilian technology company focused on APIs (Application Programming Interfaces), Agile Architecture, and API Management solutions is starting its business in the US. For the first time in the Gartner’s Magic Quadrant for FullRead more

    • What CIOs need to know about Microservices

      By Lucas Tempestini | 0 comment

      Microservices has gained a lot of strength during the last few years, and no wonder why. With poster boys like Amazon and Netflix, it’s hard to argue against it. But what do CIOs need toRead more

    • What CIOs really need to know about Partner Ecosystems and Integrations

      By Eike Malavasi | 0 comment

      Imagine if everything your company needed to create was a platform, working as a means of communication so that a range of users could add content and create value to your business. Or that yourRead more

    • Open Banking

      What is Open Banking and why it can make all the difference?

      By Lucas Tempestini | Comments are Closed

      Think about a while ago, when banks started to offer digital services, like Internet Banking or apps. How did you feel? Comfortable, modern, with a first-class service? Before that, could you imagine yourself performing aRead more

    Leave a Comment

    Cancel reply

    Your email address will not be published. Required fields are marked *

    Categories

    • Analytics
    • API
    • Digital Business
    • Events
    • Internet of Things
    • SOA
    • Uncategorized

    Tags

    Acquisitions API API Design API Economy API Management API MANAGEMENT PLATFORM API MANAGEMENT SOLUTIONS API Platform APIs APIs Management Architecture Banks Business Business Model Development Digital Ecosystem Digital Experiences Digital Strategies digital transformation eCommerces ecosystem Ecosystems Event Driven Architecture Events Financial Services Full Lifecycle API Management Global Health Home Home Insurance Innovation Insurance APIs Integration Integrations International Management Market MicroServices Omnichannel Partner Partners Ecosystem Retailes Security Strategy Technology

    Recent Posts

    • Black Friday Post – The Via Varejo experience
    • The importance of a good support service
    • Optimizing Event Driven Architecture in Java (from the low level)
    • The importance of using metrics in APIs
    • Preparing for Black Friday | E-commerce
    • Política de Privacidade
    Copyright © 2020 Sensedia | All Rights Reserved
    • API Products
      • API Management Platform
      • API Governance
      • Event-Driven Architecture
      • Service Mesh & Microservices Architecture
      • PCI
      • Flexible Actions
    • API Services
      • Consulting & Professional Services
      • Developer Experience
      • API Care
    • Solutions
      • Insurance
      • Open Banking
      • Retail & E-commerce
    • Blog
    • Contact
      • Contact
      • Customers
    • Career
    • English
      • Portuguese (Brazil)
      • Spanish
    Sensedia