Defining API guidelines for a company: What works?

It’s normal, particularly in large companies, for various product/service groups to follow along with their very own guidelines and finest practices for API design. When companies grow via a merger or acquisition, much more variety will get put into this mixture. The issue with getting different API guidelines for every team includes, however is not restricted to:

• The greater difficult it's for API consumers like developers to utilize APIs, the not as likely they'll stay with guidelines.
• It’s harder to construct common/re-functional tools and procedures, which results in repetitive efforts across teams and wastes valuable engineering time.
• A rise in time to promote for solutions built on the top of APIs due to a number of APIs boosts the time for you to integrate into solutions.

While the necessity to have common API guidelines across a business is obvious, the entire process of defining them could be a bumpy otherwise contacted sensibly with sensitivity. Here’s what labored for all of us:

1. Begin with one API style and increase the - There’s no requirement for mandating one API style over others (REST/GraphQL/Event Driven/gRPC). There'll always be legitimate use cases when one style fits best. Begin by defining API guidelines which are more generally used/needed API styles, adding more when existing types don’t meet your needs. Within our situation, we began with REST guidelines.
2. Gather a little working group - Form a little core group of 2 or 3 individuals who draft the rules. Smaller sized groups work well and faster. It is usually simpler to possess a proposal reviewed with a large group rather than have 24 people think of a draft proposal.
3. Get up on shoulders of giants - You will find enough printed guidelines available, and it seems sensible to construct on the top of a couple of of individuals rather of making your personal on your own. We based our work (and gave credit where it had been due) around the REST API guidelines printed by Microsoft, Adidas, EMC, Apigee, and JSON API. We simply altered what didn’t fit for all of us.
4. Take a wide open source approach - Treat the rules as free code. Getting a repo on GitHub/Bitbucket causes it to be simpler to collaborate, lead, and review.
5. Review and debate having a broad audience - When the your draft is prepared, it must undergo and review, discussion, and debate having a broader audience. Within our situation an API virtual team was produced, which incorporated people all major service and product groups in the organization. Consider using recurring conferences having a specific diary for each meeting. The participants should evaluate the agenda sections and are available using their feedback and comments. These sessions are often very intense and entail passionate debates, that is good. You should record the conferences for review and take detailed notes/action products for follow-up. The follow-up products could be discussed on Slack and resolved prior to the next meeting. The alterations made according to feedback are circulated in Slack as pull demands, which may be further discussed and finally decided and merged. The entire process will require multiple days with respect to the quantity of sections within the guidelines, but it's critical because it’s where real collaboration and polishing happens.
6. Get formal sign-off - After research around the guidelines, you should obtain a formal sign-removed from all of the collaborators to make certain that everybody had an opportunity to see clearly, get questions clarified, provide feedback, and show their readiness to consider it for the future API design. It’s interesting how many people start out seriously only when they're requested to formally sign off. And it is always better to obtain the sign-off/objections sooner than later.
7. Disseminate broadly - Once you’ve become a proper sign-off in your guidelines, you need to broadly disseminate it in the organization. Recruit a senior executive to talk about the announcement to any or all of engineering for greater impact.
8. Produce a Slack funnel for support - As increasing numbers of people feel the guidelines, they've already questions. Consider using a passionate Slack funnel to go over individuals questions. Within our situation, the slack for that API virtual team is available to everybody, meaning all of the discussions throughout the draft and review stages are for sale to everybody who's interested. Getting all API virtual team people on a single channels helps scale the responsiveness from the funnel.
9. Result in the guidelines obtainable in PDF format - While Git/Bitbucket repos are an easy way to collaborate around the guidelines, once it's approved, it’s useful to possess a readers-friendly format from the guidelines for simple consumption. Within our situation we produced a Jenkins job to write a PDF form of the rules each time a PR was merged to understand.
10. Train and socialize - Creating offline and classroom-based training material for that guidelines is a great way to increase awareness and adoption.

A developer conference focused on the future of work: Citrix Converge

At Citrix Synergy 2019, we announced the intelligent experience for that Citrix Workspace, that will launch later this season. The most recent evolution of Citrix Workspace provides actionable notifications and intuitive microapp workflows which are more popular business applications. By eliminating context switching and distractions, workers are empowered to become productive and work more proficiently.

Because watch is exclusive, you will find numerous applications that may be linked to Citrix Workspace. Therefore, Citrix is enabling customers and partners to personalize and extend the Workspace by creating their very own microapps and application integrations. Developers may use APIs and “low-code” tools for connecting any company application as well as an intuitive workflow builder to produce microapps for this.

That is why we’re hosting Citrix Converge - to assist developers know how the Citrix Workspace platform functions and the way to use low-code tools to produce compelling integrations.

This invitation-only event - happening October 2-3, 2019, at our campus in Santa Clara, CA - brings together technical staff from system integrators, ISVs, developers and people to:

Connect - along with other developers and partners thinking about building integrations for Citrix Workspace.

Be Inspired - see what others have built and comprehend the number of options from the Citrix Workspace platform.

Learn- building low-code microapps and integrations around the platform.

Build - integrate systems and implement use installments of interest to attendees while in the event.

During the period of the 2-day event, we’ll combine technical talks regarding how to integrate having a hackathon to place everything into practice. As you’d expect, you will see prizes to find the best integrations built! And, as you may also expect, you will see pizza, beer, and lots of coffee.

More details:

• The big event costs nothing, but we ask that you simply cover your personal transportation and lodging costs.
• Worried you cannot exist? We’ll be recording all of the talks and publishing them, so you can get all of the content, wherever you're.
• Unsure when the event is perfect for you? Should you know very well what REST APIs and JSON are, and the way to make API calls, you’ll your style in.
• Are you currently wondering what you could integrate? Most contemporary SaaS systems and applications having a REST API could be integrated directly with no single type of code. Other applications may require a little custom transformation layer that exposes a JSON REST API for Citrix Workspace.

New EU region support for Citrix Analytics

Citrix is happy to announce that Citrix Analytics has become obtainable in the Citrix Cloud Eu region. Which means that customers running Citrix Analytics within the Eu region will process and retain data for the reason that region. With this particular new option, Citrix’s European customers and partners can meet many data compliance along with other regulatory needs and can convey more control of their data.

Getting began is simple. New Citrix Cloud customers have to make certain they choose the Eu his or her home region. It’s an easy process, and you may find more details here. Existing Citrix Cloud customers already while using Eu region can launch Citrix Analytics in the tile around the primary services page.

Even though you’re around the What’s New page, you’ll also learn more and links to many recent updates, including support for on-premises StoreFront, custom reports, fortunate user monitoring, weekly email summary, and delegated administrator.

For Citrix customers and partners in Asia, please stay tuned in. Citrix is trying to offer the Asia Off-shore South region of Citrix Cloud, too. At Citrix we attempt to provide flexible options to better serve our customers and partners. Providing you with additional control over your computer data is simply one more way we’re doing that.

Preparing the next generation of engineering leaders

Remember your school days. I bet you are able to recall somebody that formed the path of your existence. Could it have been an instructor who inspired you to definitely become familiar with a language and visit new countries. Or perhaps a volunteer organization that helped you discover the journey. For me personally, individuals special everyone was my French teacher and also the Society of Hispanic Professional Engineers (SHPE).

SHPE is really a non-profit group focused on “changing lives by empowering the Hispanic community to understand its maximum potential and also to change up the world through STEM awareness, access, support, and development.” SHPE’s mission statement did, actually, change my existence and grew to become my reality. The audience formed the path of my college studies, solved the problem remain focused, gave me coaching and mentoring sources, and, through their leadership development possibilities, trained me the required skills to get an engineering leader.

Checking up on Rapid Change

An area SHPE emphasizes most is the requirement for continuous learning to maintain the rapid pace of engineering progress. This really is nowhere more apparent compared to Citrix’s product migration towards the cloud. This evolution has necessitated a paradigm shift in the manner engineers deliver software to have an atmosphere that has to guarantee no downtime, which has unpredictable peak demands and also over which we've little control.

The deployment, monitoring, recovery and fault-tolerant tools and methodologies essential to provide our services are new or continue to be developed. Citrix engineers must deal with these deficiencies by developing their very own resiliency and knowledge analysis tools to supply our customers using the guaranteed services. In a nutshell, we're breaking new ground and growing a brand new skillset not the same as that which was formerly employed for on-premises products.

While cloud technologies have been in existence for a long time, college curriculums happen to be slow to include research and training on these new programming platforms. The Citrix executive team and hiring managers recognized that we have to take an energetic approach in conclusion the space within the skills we want versus what universities are supplying.

A Skills Gap

We've not been alone in realizing a technical skills deficiency.

Lately, Microsoft announced a partnership with five universities to “help students get ready for the roles of tomorrow within-demand technologies in fields like artificial intelligence, information technology, cybersecurity and knowledge science.”

That is why, Juan Rivera, Senior VP of Cloud and Server Engineering, began the Engineering-College Relations initiative last This summer. Additionally to growing recognition of Citrix’s brand on college campuses, its primary goal would be to prepare students for that technologies that Citrix will require within the next couple of years. Since that time, Citrix has invested money and time into getting relating to this change:

• Recent graduates and interns within the Uk visited eight universities to focus on the most recent Citrix technologies with hands-on demos.
• The engineering team in Raleigh, New York, backed a hackathon with New York Condition College to supply students with coding possibilities using cutting-edge techniques.
• We located a pre-placement workshop in Bangalore, India, which was attended by 250 students to assist them to hone their resumés and interview skills and get ready for coding exams. It was additionally to tech talks on IoT technology, trends, and avenues for research and innovation to stimulate ideas in this subject.
• In Patras, A holiday in greece, Citrix backed two college labs and provided all of them with Citrix software and training, which permitted students to know the strength of virtualization.
• Citrix engineers held multiple workout sessions at local universities in Nanjing, China, to educate current virtualization and cloud technologies, in addition to, to supply insights to return of cloud-computing.
• Citrix backed the SHPE leadership conference (pictured below) in Miami, Florida, where last April I trained two workshops on building high-performance teams able to tackling the short changes of the cloud world.

Deployment guides on Citrix Tech Zone are here!

As humans, we're incredibly capable. We’re in a position to learn, to reason, and also to decide. That stated, we are able to frequently take advantage of a hands-on prescriptive approach. We use recipes to prepare and bake to attain consistent and desirable outcomes (with possibly just a little improvisation on the way). We go to the doctor’s office when we’re not feeling well and therefore are given a prescription for medicine, including instructions about how frequently to eat it, and then any additional treatment advice. We follow instructions to construct an espresso table, toy house, or perhaps a go-cart (some set up is definitely needed). I’m very happy to announce there are prescriptive, technical advice for Citrix solutions. Presenting deployment guides, available these days on Citrix Tech Zone.

Deployment guides provide step-by-step directions to assist accelerate your Citrix implementations and be sure their success. Much like a hands-on lab guide (however with a genuine-world production atmosphere focus), they contain history, various sections/tasks, overviews from the “what and why’ for every concept, individual steps with screenshots, section summaries, tips and methods, plus much more.

Find Out About Citrix Files within our First Deployment Guide

Our first deployment guide is Citrix Files with Citrix Virtual Apps and Desktops Service. Inside it, we cover how you can install and configure the Citrix Files client to be used using the Citrix Content Collaboration service in virtualized environments. We walk-through the next:

Graphical user interface and command-line installing of Citrix Files for that VDA

Provisioning options

Using session lingering

Testing access and SSO

Configuring file type association (FTA)

Configuring GPO settings for Citrix Files

Profile containers and profile management

In situation you couldn’t tell, I needed to state that I’m looking forward to this official launch of deployment guides! According to my 11  experience at Citrix, I'm able to easily state that step-by-step guides such as this are extremely popular. In 2014, I provided a XenDesktop 7.1 on Hyper-V Pilot Guide with detailed assistance with an entire build-out. That guide has gotten a large number of downloads up to now, together with many positive comments. I’m expecting similar interest using the many deployment guides we intend to release, so stay tuned in for additional content within the coming several weeks!

We Want Your Feedback

Lastly, when i frequently do, I wish to close around the subject of feedback. I can’t stress how critical it's for all of us to provide the very best, best happy to you. Actually, our publication from the Citrix Files deployment guide as our first deployment guide was driven mainly by customer and partner feedback.

Desktops-as-a-service pilot kicks off for U.S. partners

Citrix is dedicated to positioning our partners for achievement. To that particular finish, we’ve launched someone pilot program for that new Citrix Managed Desktops service in front of the global release. As announced at Citrix Synergy in May, we're launching an earlier adopter program for qualified U.S. partners thinking about building choices for this new Citrix desktops-as-a-service solution.

This pilot program enables select U.S. Citrix funnel partners to start creating a comprehensive desktops-as-a-service solution on Azure for his or her customers. It’s an incredible chance for partners to showcase the brand new solution before it might be globally available and also to offer customers Home windows apps and desktops from Azure. Pilot program partners will create our broader funnel to leverage the strength of Citrix Managed Desktops inside their portfolio.

Citrix Managed Desktops is really a new simple, turnkey desktops-as-a-service solution which includes everything partners have to rapidly deliver Azure-located, Home windows virtual apps and desktops for their users with minimum management. This particular service is fantastic for organizations that are looking to supply secure use of Home windows applications and desktops for their workers, wherever they're or what device they're using, within the simplest, fastest way.

Selling Citrix Managed Desktops provides advantages to partners, including:

Faster sales cycles: Faster POCs and rapid deployment equals faster time for you to revenue

Simplify IT management: Citrix manages updates towards the OS, simplifying catalog management

Partner value-add services: Image and profile management, user provisioning, vertical personalization

Microsoft licensing revenue

Flexible service: Grows with companies and enables quick deployment for business continuity and temporary workers

Tips for evaluating API management solutions

Evaluating API Management Solutions

• Find out the abilities/features needed - It’s vital that you be obvious around the business objectives and be sure your technical abilities serve individuals objectives. Assessing a solution’s technical abilities without understanding the thing you need is really a prime pitfall to prevent. It isn't easy, though. The thing you need could be a moving target, as well as your needs can evolve with learning and feedback. But it’s vital that you stay on the top of individuals needs and know very well what you'll want, what you need to have, and just what could be nice to possess.
• Read analyst reports - Analyst reports could be an excellent source of information for in-depth, comparative study of numerous vendor choices. Sometimes you are able to download reports free of charge by completing an application together with your contact details.
• Attend an API conference -  Attending occasions like API World, API Days, and REST Fest can help you stay current on what’s happening in the realm of APIs. You’ll have the opportunity to interact with and discover from awesome technologists who're by themselves API journeys and talk with representatives from vendor companies.
• Give it a try - Doing POCs having a couple of shortlisted options is the easiest method to get an understanding of using a solution and it is documentation, forums, and support channels. Additionally towards the solution features, the expertise of others and also the ease of access from the product and support teams ought to be an issue inside your decision.
• Consider nonfunctional needs - Nonfunctional needs like cost/prices, latency, and security should play an important role inside your assessment.

Applying an API Management Solution

• Come to a decision - After doing all of your research, create a time-bound decision. Lots of learning and feedback come once you place the platform and APIs onto it. Comparative studies can embark upon forever and then leave you with no apparent choice. You will see trade-offs involved, so sooner or later you need to commit and move ahead. It’s smart to share and evaluate the evaluation with as numerous stakeholders within the organization as you possibly can. That provides you with valuable and various perspectives and can raise legitimate concerns early along the way.
• Test the waters - When confronted with a mystery, it’s best to avoid lengthy-term decisions that you simply can’t change with time. For instance, with commercial solutions, multi-year contracts might be economically attractive although not prudent unless of course you are able to justify your roi.
• Build for change/evolution - Regardless of how great something looks at first, learning and new needs might need you to pivot. Be ready to evolve with time. Perfect decisions are rare. Good-enough decisions can allow you to make progress, if you realise and adapt while you move ahead. It’s normal for services and products to endure multiple transformations once they are launched.
• Consider mixing multiple solutions - Sometimes the very best path is to blend multiple solutions. For instance, one element of your API management system might be free, another could originate from an industrial vendor, but still another might be coded on your own. One solution/vendor that fits all of your needs isn’t always available.

With regards to your API journey, begin with where you stand, keep on your journey to your north star, and also have a little fun on the way. Look out in my next publish around the new Citrix APIs for Cloud Services site