Meta tags:
description= Learn to publish your first API reference in Document360, from uploading your spec file to creating a live, interactive developer portal.;
Headings (most frequently used words):
api, documentation, the, your, and, to, import, spec, upload, file, use, getting, started, with, index, prerequisites, navigate, workspace, choose, how, specification, review, alerts, warnings, publish, reference, configure, authentication, for, try, it, set, reader, access, privacy, from, url, ci, cd, flow, oauth2, openid, connect, additional, configuration, no, sample, pet, store, document360, top, features, support, contact, us,
Text of the page (most frequently used words):
the (77), api (56), your (39), and (30), you (25), file (25), document360 (21), #documentation (20), spec (19), reference (18), url (16), for (13), #import (12), this (12), from (11), can (11), knowledge (9), base (9), with (9), article (9), try (9), click (9), are (8), will (8), note (8), openapi (8), upload (8), articles (7), before (7), access (7), not (7), that (6), have (6), users (6), authentication (6), use (6), review (6), window (6), select (6), warnings (6), create (6), new (6), site (5), portal (5), request (5), when (5), reader (5), content (5), workspace (5), specification (5), automatically (5), add (5), key (5), custom (5), cli (5), command (5), yaml (5), 2026 (5), support (4), com (4), analytics (4), integrations (4), getting (4), started (4), interactive (4), set (4), one (4), categories (4), publish (4), public (4), view (4), oauth2 (4), supports (4), after (4), how (4), method (4), full (4), logs (4), section (4), alerts (4), sample (4), path (4), option (4), flow (4), open (4), page (4), about (3), features (3), private (3), troubleshooting (3), references (3), next (3), defined (3), apis (3), any (3), endpoint (3), published (3), navigation (3), apidocs (3), permissions (3), settings (3), only (3), visible (3), these (3), authorization (3), token (3), oauth (3), example (3), https (3), openid (3), connect (3), two (3), console (3), endpoints (3), methods (3), passed (3), draft (3), mode (3), want (3), live (3), replace (3), detected (3), pet (3), store (3), copy (3), available (3), json (3), yml (3), ask (3), policy (2), privacy (2), our (2), contact (2), feedback (2), drive (2), workflow (2), extensions (2), top (2), hosting (2), security (2), issues (2), managing (2), decision (2), fundamentals (2), was (2), application (2), through (2), also (2), provides (2), own (2), enabling (2), manage (2), display (2), yet (2), making (2), readers (2), configure (2), navigate (2), some (2), without (2), internal (2), control (2), server (2), correctly (2), feature (2), during (2), need (2), manually (2), domain (2), using (2), additional (2), multiple (2), testing (2), generated (2), header (2), works (2), developers (2), directly (2), must (2), them (2), regenerate (2), resync (2), publishing (2), shows (2), created (2), make (2), mean (2), again (2), details (2), uploading (2), summary (2), ready (2), prompted (2), later (2), update (2), value (2), valid (2), first (2), line (2), installed (2), d360 (2), updated (2), press (2), enter (2), generates (2), local (2), pointing (2), requires (2), node (2), proceed (2), formats (2), whenever (2), changes (2), hosted (2), updates (2), separate (2), either (2), each (2), bar (2), opens (2), project (2), guide (2), all (2), paid (2), workspaces (2), claude (2), chatgpt (2), markdown (2), llms (2), ctrl (2), search (2), glossary (2), october (2), docs (2), index (2), soc2, cookie, trust, center, terms, careers, culture, team, 3000, rating, status, seo, ticket, deflector, platform, assistant, enterprise, readiness, migration, demo, resources, pricing, customers, tree, related, previous, yes, helpful, programming, interface, rules, protocols, allows, software, communicate, functionality, another, backbone, modern, connects, slack, intercom, google, does, their, its, rest, teams, programmatically, accounts, external, systems, visiting, return, 404, error, there, applies, added, link, least, accessible, important, locate, sections, others, restricted, mixed, anyone, partner, what, means, setting, who, see, configuring, button, check, both, variable, function, refreshes, background, active, sessions, authenticate, silent, renewal, provider, yourdomain, redirect, uri, required, configuration, schemes, simultaneously, require, combined, extends, user, identity, verification, code, pkce, client, credentials, implicit, flows, unique, headers, login, bearer, username, password, basic, following, lets, test, work, configured, useful, individual, retained, saved, pane, close, confirmation, number, has, been, processed, successfully, failed, most, common, cause, unsupported, format, invalid, correct, errors, imported, but, elements, may, expected, more, icon, many, were, along, explore, then, running, old, longer, apikey, installs, tool, run, once, already, skip, npm, install, paste, terminal, uploads, yourname, projects, copied, shown, system, fetches, processes, they, field, parses, appears, expand, drag, drop, supported, device, definition, automates, via, pipeline, every, change, point, same, stable, best, quickly, infrequent, locally, ways, way, automate, choose, maximum, within, dropdown, left, dedicated, standard, log, still, follow, setup, postman, collection, subscription, starting, sure, prerequisites, plans, plan, includes, purchased, ons, browsable, end, walks, developer, prev, plain, text, print, listen, focus, minute, read, jun, sep, powered, community, self, service, help, november, release, notes, integrate, manager, customization, export, reminder, collaboration, tasks, trees, fields, management, templates, variables, snippets, advanced, editor, single, sign, role, based, languages, creators, eddy, track, roles, invite, customize, quick, start, discover, pages, exploring, further, fetch, complete, txt,
Text of the page (random words):
getting started with api documentation documentation index fetch the complete documentation index at https docs document360 com llms txt use this file to discover all available pages before exploring further quick start create an article review article publish article customize site invite users set up roles permissions track analytics eddy ai features for creators for readers for integrations key features multiple workspaces languages role based access control single sign on private hosting advanced editor templates variables snippets glossary drive file management custom fields interactive decision trees collaboration tasks custom workflow review reminder import export project site customization custom domain integrations extensions analytics feedback manager api documentation integrate with document360 manage your api docs release notes november 2026 12 11 1 october 2026 12 10 2 october 2026 12 10 1 help troubleshooting self service support ask for a feature community glossary search ctrl k press ctrl k to open search powered by getting started with api documentation updated on sep 28 2026 published on jun 15 2026 6 minute s read focus listen print copy page copy as markdown for llms view as markdown view the page as plain text open in chatgpt ask chatgpt about this page open in claude ask claude about this page article summary prev next this guide walks you through publishing your first api reference in document360 from uploading your spec file to a live interactive developer portal by the end of this article you will have an api reference generated from your openapi specification your endpoints visible and browsable by developers the try it interactive console ready for live api testing note api documentation is available on all paid plans each paid plan includes one api workspace additional workspaces can be purchased as add ons prerequisites before starting make sure you have a document360 subscription an api specification file in one of these formats openapi 3 2 openapi 3 1 openapi 3 0 openapi 2 0 or postman collection either as a local file json yaml or yml or hosted at a url you ll import from access to the knowledge base portal with permissions to create content note if you do not have a spec file yet you can still follow this guide using the sample pet store api file that document360 provides you will be prompted to use it during setup navigate to the api documentation workspace log in to document360 and open your project in the knowledge base portal in the left navigation bar click api documentation this opens the dedicated api workspace separate from your standard knowledge base in the top navigation bar click the create dropdown and select new api this opens the new api reference window note you can create a maximum of 3 api references within each api workspace choose how to import your spec document360 supports two ways to import your spec file file upload and url import the ci cd flow is not a separate import method it is a way to automate either of these two methods so that your documentation updates automatically whenever your spec changes method when to use it how it works file upload you have the spec file locally as json yaml or yml upload the file directly best for getting started quickly or for infrequent updates url import your spec is hosted at a stable public or internal url point document360 to the url you can manually resync from the same url whenever the spec changes ci cd flow you want documentation to update automatically on every spec change automates file upload or url import via the d360 cli in your pipeline requires node js upload your specification upload a file in the new api reference window select the upload api definition option click upload from my device or drag and drop your file supported formats json yaml yml document360 parses the file and generates the api reference automatically if warnings are detected an alerts and warnings section appears expand it to review them you can view full details later in the logs section click new api reference to proceed import from a url in the new api reference window select the create from url option and click next enter the url pointing to your openapi specification file in the url field document360 fetches and processes the spec if warnings are detected they will be available in the logs section after import click add api reference to proceed use the ci cd flow note this option requires node js to be installed on your system in the new api reference window select the ci cd flow option copy the full cli command shown in the window in the copied command replace the path value with the full path to your local spec file or a valid url pointing to it for example path users yourname projects api openapi yaml or a url path https example com api openapi yaml paste the updated command in your terminal and press enter document360 uploads your spec and generates the api documentation note the first line of the cli command npm install d360 g installs the document360 cli tool you only need to run it once if it is already installed you can skip that line if you regenerate your api key you must update the apikey value in your cli command before running it again the old key will no longer be valid no spec file use the sample pet store api if you do not have a spec file ready select try sample pet store api file when prompted document360 will automatically create a sample api reference in draft mode you can explore it and then replace it with your own spec later review alerts and warnings after uploading your spec document360 shows you a summary of how many categories and articles were created along with any alerts or warnings detected in your file alerts and warnings mean the spec was imported but some elements may not display as expected you can review the full details in the logs section go to your api reference click the more icon and select logs errors mean the import failed the most common cause is an unsupported file format or an invalid url replace the file or correct the url and try again publish your api reference after your spec has been processed successfully a confirmation window shows the number of categories and articles created click publish to make the api reference live if you want to review the content before publishing click close your api reference is saved in draft mode and visible in the categories articles pane note draft mode is useful if you want to add custom content to individual endpoint articles before making them public any custom content you add will be retained when you regenerate or resync your documentation configure authentication for try it the try it console lets developers test your api endpoints directly from the documentation for it to work correctly the authentication method must be defined in your spec and configured in document360 document360 supports the following authentication methods method how it works basic authentication username and password passed in the request header bearer token a token generated after login passed in the authorization header api key a unique key passed in the request headers oauth2 supports authorization code pkce client credentials and implicit flows openid connect extends oauth2 to add user identity verification note the try it console supports multiple security schemes simultaneously enabling testing of endpoints that require combined authentication methods oauth2 and openid connect additional configuration when using oauth2 or openid connect two settings are required redirect uri set this in your oauth provider to domain oauth for example https apidocs yourdomain com oauth silent renewal document360 automatically refreshes the authorization token in the background during active try it sessions so users do not need to re authenticate manually note if the try it button is not visible on your knowledge base site check that both the server variable and the server url are correctly defined in your api specification file without these the try it feature will not function set reader access and privacy control who can see your published api reference by configuring reader access settings setting what it means private only users can view the api reference use for internal or partner only apis public anyone can access the api reference without authentication mixed some sections are public others are restricted to users to configure reader access navigate to settings users permissions reader access in the knowledge base portal and locate your api documentation workspace important visiting apidocs before any endpoint articles are published will return a 404 error there is no content to display yet this also applies if you have added a navigation link to apidocs on your knowledge base site publish at least one endpoint article before making your api reference accessible to readers application programming interface a set of defined rules and protocols that allows one software application to communicate with and request functionality from another apis are the backbone of modern integrations when document360 connects to slack intercom or google analytics it does so through their apis document360 also provides its own rest api enabling teams to programmatically manage articles categories and reader accounts from external systems was this article helpful yes no previous article api fundamentals next article managing api references related articles api fundamentals interactive decision tree api documentation managing api references api documentation getting started with api documentation troubleshooting api import issues api documentation troubleshooting api documentation issues document360 customers pricing resources request a demo migration request security private hosting enterprise readiness top features knowledge base portal knowledge base site knowledge base assistant integrations and extensions platform api analytics workflow ticket deflector drive seo support documentation support status feedback contact us contact us support document360 com rating 4 7 3000 about us our team our culture careers terms trust center privacy policy cookie policy soc2
|
