These markdown files will provide all the info you need to get going to onboard into the Developer Studio.
- The Studio Community (Metaphor)
- Directory of files
- Developer Studio Demos
- Below are the steps you need to follow:
- Getting Help
The way we describe the Developer Studio is that it is a apartment complex and each of you are tenants within the complex. (hint: Still not sure what a tenant is? Checkout the glossary)
While we, the DevStudio team, are the HOA.
Just like how you move into your apartment you can bring along your furniture (your content) and decorate your apartment (within limits dedicated by the HOA (i.e. DevStudio team)).
- You create/edit/publish your own documentation and APIs at your liesure
- You can provide your own live sandbox
- You can provide your own API management system. Check out our docs on Enabling Workspaces.
Because the Developer Studio is meant to unify all our products under a single portal that means there are guidelines you must follow.
- You must provide Basic Tenant Information such as name, desctiption, business type, product tags, etc.
- You must have API documentation in markdown format and for that use our Markdown syntax
- You must have a getting started section
- You must be on Openapi specification 3.0+
- You must have Release Notes as part of the documentation that follow our guidelines
Hint: When in doubt look at Commerce Hub as an example of what to do.
There is pretty little you cannot do. If you're not sure, shoot us a message using our Support or through our Teams channel.
Checkout the demo page to see demos of our features.
- Decide your integration level:
- Full Service Tenant: Open API YAML file, Markdown Documentation and Live Sandbox Integration/Prism Mock Server Integration
- Doc Only Tenant: Markdown documentation only
- Linkout Tenant: External link from our Catalog page to the Tenant Developer Portal/website. Basic Tenant Information
- Get your info together:
- Product Description
- Markdown Documentation
- OpenAPI Spec file in YAML format (Version 3.0.0 and above)
- Who is it for description (for link out tenants)
- 1-3 UseCases/Popular Services
- Signup for a free github account:
- Each tenant needs to register into github using their Fiserv email address and create an account. Once an account is created, please provide the Github username/registered email address to Developer studio team/Tenant Advocate.
- It would help to use Stoplight or Swaggerhub Editor to edit/debug your docs and spec contents.
- Swagger at https://fiserv-portal.stoplight.io/
- Spotlight at https://editor.swagger.io/
- A tenant advocate will be assigned who would act as a Github admin to help the tenant get started.
- Wait for your tenant space to be provisioned.
- Submit your info to a Tenant Advocate by creating a github issue in Support.
- Minimum Required Documents:
- Getting started markdown file
- API specification file (yaml)
- 1-3 use case (1 use case with 1 related document and 1 related api)
- Structure of the Tenant Repository: The Tenant Advocate will create a repository under Fiserv Github organization.
- Assets: Folder containing subdirectorys with various reference resources
- Images: Raw images, logos, gifs, etc. for displaying in markdown documentation. See attaching images
- Files: PDF, docx, ppt, files etc. stored for other tenant team members to use OR for downloading from links in markdown documentation. See creating downloadable file links
- Config: Folder containing
document-explorer-definition.yamlfile,product-layout.yamlfile, andtenant.jsonfile outlining the structure of documentation, doc tree and product page. - Docs: Folder containing all markdown files that gets displayed on documentation explorer part of Dev Studio. The documentation is captured in markdown format (.md file) only. Please do not put MD files in other locations as they may not get picked up by our webhook and indexing services.
- References: Folder containing all API yaml files that gets displayed on API explorer part of Dev Studio for one or more version. All API yaml files must contain a version number so that the right yaml is fetched when user selects a certain version. The same version number must be referenced in the
tenant.jsonfile - .Docignore: File containing list of files to be ignored by our indexing/webhook services (even if they are located in one of the aforementioned directories). Useful for hosting internal How-to and documentation for your other team members.
- Assets: Folder containing subdirectorys with various reference resources
- Read up on how to use your space and modify content: Configure Tenant
- OpenAPI spec and API Explorer page
- Add content based on your integration level Once you're happy with your content create another github issue to get deployed into upper environments and production
Refer to the table contents to the right to get more details about each step.
If you want to manage your product in terms of providing your MIDs, API keys, CSRs, analytics, etc. via various systems such as Apigee, read more about this here: Workspaces
If you want to provide highly controlled access to various documents available for download from your repository, read more about this here: How to use Gated Content 13. Your GitHub contents would be validated to check for accuracy and any syntax error. Read more about this here: GitHub validators
If you need help, spot bugs, need enhancements, or just want to chat you've got some options below.
- How to Get Support
- Bugs / Enhancements / Questions
- Go to our Support
- All of the above or to chat with the team
- Go to MS Teams and search for
Developer Studio from Fiserv
- Go to MS Teams and search for
Ok, let's get started!