Introducing Mashery

Mashery powers Web Service Providers and the Developers who are building the next generation Internet applications. Using a Mashery-powered Portal, Service Providers can build an active Developer community by using the Portal to provide content, forums, and blogs centered around their APIs. A single Mashery Developer account allows a Developer to interact with and integrate Web Services from any Mashery-powered Service Provider, yet maintain a distinct relationship with each vendor. For both Service Providers and Developers, Mashery also provides API tracking, metering, and security - to help provide intelligent, flexible access to critical data.

How It Works

As a Service Provider, we encourage you to scan our Developers' Getting Started Guide and to explore the Mashery web site as an example of a vendor Portal. Once you have set up as a Service Provider with Mashery, you will have access to two tools: a Mashery-powered Portal to provide content designed to support the Developers using your APIs and Web Services and Mashery APIs to provide tracking statistics. Using the data from the Mashery API, Mashery provides you with reports on Developer interactions with your Portal. Using these tools, you can build a solid, quantifiable relationship with your Developers and understand how your data is being used in the Community.

The Mashery account is at the heart of our system, providing an integrated view of your relationship with each of your Developers, while making it easy for them to find your data and services. Here's how the Mashery accounts work to help you grow your Developer Community:

  • Your Mashery Developers. One login allows our Developers to contribute to your documentation, ask questions in your forum and leave comments on your blog. They can also create and publish new wiki pages on their areas of expertise. The same login will let them manage their Developer and API keys so both can have identifying information on usage, and allow you to track and (in the future) monetize Web Service calls.

  • Your Developers. If you have existing Web Services with a registration process, Mashery can integrate with you on configurations such as Developer import and conversion, merging, or custom synchronization or authentication back to your user data base.

  • Mashery Developers. You'll have access to a pool of ready-trained Developers interested in Web Services and who have prior exposure to Mashery. You can reach them using the Mashery API Directory and API search.

  • All Developers. Developers new to both you and Mashery can get quickly up-to-speed with your offerings, documentation, support and infrastructure. Having all these great tools and information integrated are a powerful advantage when appealing to a Developer Community interested in openness and shared participation. Mashery's API directory will also serve as a central listing service, helping Developers find you.

Planning Your Portal

Developers access your API and your content through your Mashery-powered Portal. Complete information the mechanics of setting up your Portal is available in Configuring the Portal, but this summary of the relevant tasks can make the implementation process easier. Consider these tasks when planning your Portal offerings:

  • Assemble existing content such as API documentation, product announcements, Terms of Service agreements, Privacy Policy statements, and other text that assists Developers in using your APIs.

  • Determine portal offerings for presenting your content. Your Portal can offer content in the following modes: custom pages, documentation, a blog, a wiki, and an interactive forum. Many of these modes have configurable features, such as allowing comments or requiring moderator approval for new content.

  • Develop standards for your content. A few minutes of thought regarding filespace structure, page order, and standard content tags can reduce hassle as your Portal content grows.

  • Provision administrators in your organization to create, manage, and moderate content. The level of participation you need and the distribution of tasks among your team members is influenced by the content areas offered in your Portal. Consider who is responsible for tasks such as creating blog entries and monitoring forum conversations.

  • Announce your Portal to existing Developers and register new Developers for your services.

  • Continue enhancing the content and offerings of your Portal. The best practice is to start small, and add Portal content and features as the capacities of your team and the needs of your Developers grow.

Accessing the Dashboard

Use the Dashboard to set up and manage your Portal. To access your Mashery-powered Portal:

  1. Go to the URL assigned for the Portal. (Contact Mashery if you do not know your Portal's URL.)

  2. Click Sign in.

  3. In the Login box, choose the login method you want to use and enter your username and password. Click Sign In.

  4. After signing in, click Dashboard in the upper right corner of the page to enter the Dashboard with all content controls and management tools. To see the Portal as it is displayed live, click Portal. To see from the Developer's point of view you will need to sign out of your account with Moderator or Administrator permissions.