Meta tags:
description= Transform your API references with Document360 s interactive documentation, reducing integration time and building developer trust effortlessly.;
Headings (most frequently used words):
documentation, api, and, it, openapi, panel, support, fundamentals, index, the, reader, experience, what, is, why, does, matter, vs, regular, supported, specification, formats, webhooks, in, authorization, techniques, faq, code, response, try, authentication, variables, eddy, ai, oauth2, openid, connect, additional, configuration, adds, for, document360, top, features, contact, us,
Text of the page (most frequently used words):
the (66), api (55), and (40), for (30), #documentation (27), your (25), document360 (20), with (16), openapi (14), from (14), reference (13), try (13), request (12), specification (12), can (12), support (10), that (10), see (10), file (10), you (10), endpoint (10), article (9), readers (9), knowledge (8), base (8), this (8), example (8), authentication (8), what (8), code (8), are (7), categories (7), not (7), how (7), developers (7), docs (7), page (7), 2026 (6), when (6), use (6), users (6), each (6), response (6), about (5), site (5), developer (5), tags (5), troubleshooting (5), articles (5), does (5), through (5), their (5), tag (5), values (5), without (5), available (5), spec (5), parameters (5), authorization (5), token (5), oauth2 (5), webhooks (5), they (5), into (5), status (4), analytics (4), integrations (4), getting (4), started (4), issues (4), references (4), defined (4), apis (4), order (4), based (4), feature (4), authenticate (4), oauth (4), openid (4), connect (4), using (4), key (4), shows (4), sample (4), endpoints (4), responses (4), ask (4), eddy (4), variables (4), console (4), interactive (4), panel (4), copy (4), custom (4), team (3), features (3), next (3), set (3), reader (3), more (3), information (3), category (3), navigation (3), such (3), supported (3), server (3), url (3), will (3), create (3), methods (3), integrate (3), need (3), first (3), swagger (3), postman (3), generated (3), access (3), supports (3), self (3), schemas (3), http (3), method (3), read (3), body (3), all (3), testing (3), end (3), fields (3), time (3), every (3), any (3), open (3), policy (2), trust (2), our (2), com (2), contact (2), feedback (2), drive (2), workflow (2), extensions (2), enterprise (2), private (2), hosting (2), customers (2), help (2), release (2), notes (2), import (2), managing (2), yes (2), application (2), allows (2), one (2), provides (2), own (2), teams (2), manage (2), external (2), control (2), array (2), extension (2), organised (2), standard (2), taggroups (2), dropdown (2), only (2), these (2), ensure (2), both (2), option (2), defines (2), store (2), user (2), appear (2), default (2), workspace (2), return (2), manual (2), automatically (2), manually (2), callback (2), https (2), domain (2), additional (2), requests (2), curl (2), flows (2), credentials (2), passed (2), headers (2), bearer (2), basic (2), specific (2), following (2), payload (2), schema (2), includes (2), document (2), json (2), query (2), formats (2), content (2), full (2), static (2), live (2), internal (2), technical (2), regular (2), service (2), signal (2), product (2), quality (2), 422 (2), questions (2), reduces (2), integration (2), why (2), which (2), works (2), language (2), get (2), leaving (2), right (2), turns (2), something (2), real (2), success (2), error (2), path (2), ready (2), languages (2), side (2), publish (2), complete (2), claude (2), chatgpt (2), view (2), markdown (2), llms (2), fundamentals (2), ctrl (2), search (2), glossary (2), october (2), review (2), index (2), soc2, cookie, privacy, center, terms, careers, culture, 3000, rating, seo, ticket, deflector, platform, assistant, portal, top, readiness, security, migration, demo, resources, pricing, tools, august, related, previous, was, helpful, programming, interface, rules, protocols, software, communicate, functionality, another, backbone, modern, connects, slack, intercom, google, also, its, rest, enabling, programmatically, accounts, systems, hierarchical, symbol, names, creates, subcategory, inside, reorder, resync, vendor, grouping, changes, elements, made, modifying, currently, modified, isn, visible, variable, properly, function, could, reason, created, pet, same, ordering, uploading, within, maximum, many, resource, comprehensive, functions, classes, types, other, components, guide, who, want, applications, faq, refreshes, background, during, active, sessions, silent, renewal, provider, assets, apidocs, html, redirect, uri, working, two, settings, required, work, correctly, configuration, customer, make, authenticated, refer, making, tokens, extends, adding, identity, verification, secures, various, pkce, client, implicit, uses, unique, authenticates, after, login, requires, username, password, interacting, important, authorized, certain, data, perform, actions, techniques, event, icon, include, section, provided, uploads, imports, starting, fresh, everything, plus, additions, above, migrating, existing, setup, accepts, while, upgrade, incrementally, note, named, servers, richer, canonical, uris, streaming, sent, events, lines, device, flow, rfc, 8628, nested, hierarchies, operations, adds, files, uploaded, yml, yaml, collections, formerly, webhook, lives, dedicated, separate, different, controls, routing, branding, facing, auto, generation, managed, editorially, tied, versions, versioning, reading, via, interactivity, guides, tos, conceptual, auth, type, authored, driven, structure, integrators, primary, audience, aspect, partners, third, party, needing, hand, holding, enables, incomplete, outdated, unreliable, high, direct, builds, answer, mean, fewer, tickets, burden, clear, cut, onboarding, days, hours, spend, less, guessing, building, matters, tells, exactly, interact, exist, accept, unlike, general, follow, strict, structured, format, derived, machine, readable, matter, built, answers, let, value, once, reuse, across, saves, typing, common, move, placeholder, supply, directly, whichever, scheme, reads, schemes, details, authorizing, opens, inline, send, timing, writing, walkthrough, run, select, shape, should, expect, case, makes, easier, handle, paths, 500, 429, 404, 403, 401, 200, updates, reflect, straight, environment, javascript, java, python, shell, switch, match, stack, six, samples, panels, description, requirements, centre, grouped, subcategories, label, post, put, patch, delete, beside, filter, name, jump, quickly, left, tree, land, three, pane, understanding, layout, helps, picture, actually, points, explains, part, depth, experience, gives, solution, publishing, whether, startup, shipping, public, maintaining, dozens, microservices, polished, requiring, tooling, formatting, prev, summary, plain, text, print, listen, focus, minute, published, jun, updated, nov, powered, press, community, november, manager, customization, export, project, reminder, collaboration, tasks, decision, trees, management, templates, snippets, advanced, editor, single, sign, role, multiple, workspaces, creators, track, roles, permissions, invite, customize, quick, start, discover, pages, before, exploring, further, fetch, txt,
Text of the page (random words):
api fundamentals 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 api fundamentals updated on nov 13 2026 published on jun 13 2026 7 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 document360 s api documentation feature gives you a complete end to end solution for publishing managing and testing api references whether you re a startup shipping your first public api or an enterprise maintaining dozens of internal microservices document360 turns your openapi specification into polished interactive developer documentation without requiring any custom tooling or manual formatting the reader experience when you publish an api reference developers land on an interactive three pane page not a static document understanding this layout helps you picture what your readers actually see and points you to the article that explains each part in depth left navigation tree every endpoint in your specification grouped by tag into categories and subcategories with a method label get post put patch delete beside each readers filter by name to jump to an endpoint quickly centre documentation the endpoint s description path and query parameters request body schema and authentication requirements all generated from your spec right code and response panels ready to use request samples and example responses side by side with the documentation code panel the code panel shows a ready to copy request sample for the endpoint and readers can switch the language to match their stack six languages are available curl shell python java javascript c each sample updates to reflect the endpoint s real path parameters and authentication so a reader can copy it straight into their own environment response panel the response panel shows example responses for the endpoint organised by status code for example success and error responses such as 200 401 403 404 422 429 500 readers select a status code to see the shape of the response they should expect in each case which makes it easier to handle both success and error paths in their integration try it try it turns the reference from something readers read into something they can run it opens an interactive console inline on any endpoint so developers can send a real request and see the live response status timing headers and body without leaving the page or writing any code see testing endpoints with try it for the full walkthrough authentication readers supply credentials directly in the try it console using whichever scheme your api defines api key http basic http bearer oauth 2 0 or openid connect try it reads the schemes from your specification and shows the right fields for each see authorizing requests in the try it console for details on every method variables variables let readers store a value once such as an id or a token and reuse it across every endpoint in the reference with a placeholder this saves re typing common values as they move from one endpoint to the next see using variables in the try it console eddy ai eddy ai is built into the reference so readers can ask questions about an endpoint how it works how to authenticate or for a code sample in a specific language and get answers without leaving the page see using eddy ai in the api reference what is api documentation and why does it matter api documentation is the technical reference that tells developers exactly how to interact with your api which endpoints exist what parameters they accept what responses they return and how authentication works unlike general knowledge base articles api docs follow a strict structured format derived from a machine readable specification file why it matters reduces integration time clear docs cut onboarding from days to hours developers spend less time guessing and more time building reduces support burden when docs answer the how do i authenticate and what does a 422 mean questions your team fields fewer tickets builds developer trust incomplete or outdated api docs signal an unreliable product high quality documentation is a direct signal of product quality enables self service external partners customers and third party developers can integrate without needing hand holding from your team api documentation vs regular documentation aspect api documentation regular documentation primary audience developers and technical integrators end users internal teams structure driven by a specification file openapi postman manually authored articles content type endpoints parameters schemas auth methods guides how tos conceptual articles interactivity live testing via try it static reading versioning tied to api spec versions managed editorially auto generation yes from spec file no in document360 api documentation lives in a dedicated api workspace that is separate from your standard knowledge base this allows different access controls routing and branding for your developer facing content for a full reference of all available endpoints and schemas see the document360 developer docs supported specification formats document360 supports the following specification formats openapi 3 2 openapi 3 1 includes webhook support openapi 3 0 openapi 2 0 formerly swagger postman collections files can be uploaded as json yaml or yml openapi 3 2 adds support for the query http method for read operations that need a request body nested categories generated automatically from tag hierarchies the device authorization flow rfc 8628 as an additional oauth2 option streaming response schemas for server sent events and json lines named servers richer example values and canonical document uris self note if you re starting fresh use openapi 3 2 it includes everything from 3 1 plus the additions above if you re migrating from an existing swagger 2 0 setup document360 accepts it as is while you upgrade incrementally webhooks in openapi 3 1 document360 supports webhooks defined in openapi 3 1 webhooks appear with an event icon in your api reference and include a payload section based on your schema if no example is provided document360 shows a default example and a sample payload try it is not available for webhooks webhooks are supported for file uploads url imports and ci cd flows authorization techniques when interacting with an api it is important to ensure that only authorized users can access certain data or perform specific actions document360 supports the following authorization methods basic authentication requires a username and password passed in the request bearer token authenticates with a token generated after login api key uses a unique key passed in the request headers for authentication oauth2 secures apis through various flows authorization code pkce client credentials and implicit openid connect extends oauth2 by adding user identity verification to authenticate requests to the document360 customer api you will need an api token for more information see the api tokens article to make your first authenticated api request using swagger postman or curl refer to making your first request oauth2 and openid connect additional configuration when working with apis that use oauth2 or openid connect two settings are required for try it to work correctly redirect uri set this in your oauth provider to the api reference s oauth callback url https your knowledge base domain assets apidocs oauth callback html 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 faq what is an api reference an api reference is a documentation resource that provides comprehensive information about the functions classes methods parameters return types and other components of an api it is a guide or manual for developers who want to integrate or use the api in their applications how many api references can i create within each api workspace you can create a maximum of 3 api references what is the default ordering of categories when uploading an openapi specification file categories in document360 are created based on the tag order defined in your spec file for example if your spec defines tags in the order pet store user the categories will appear in that same order the try it option is not available on the knowledge base site what could be the reason if the try it feature isn t visible ensure that both the server variable and the server url are properly defined in your api specification file without these the feature will not function can api reference dropdown values be modified through the ui no changes to api reference elements such as dropdown values can only be made through the openapi specification file modifying these values through the ui is not currently supported does document360 support the x taggroups extension for grouping api tags no document360 does not support the x taggroups vendor extension categories in your api documentation are organised based on the standard tags array in your openapi specification to control the category order reorder the tags array and resync for hierarchical navigation use the symbol in your tag names for example a tag of users authentication creates a users category with an authentication subcategory inside it for more information see troubleshooting api category and navigation issues 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 troubleshooting ai for knowledge base site issues next article getting started with api documentation related articles managing api references api documentation getting started with api documentation troubleshooting api import issues api documentation troubleshooting api documentation issues getting started with api documentation api documentation getting started with api documentation august 2026 12 8 1 help support release notes tags developer tools openapi specification api documentation 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
|
