[{"data":1,"prerenderedAt":962},["ShallowReactive",2],{"navigation_docs_en":3,"-en-integration-api-overview":427,"-en-integration-api-overview-surround":957},[4,31,117,188,238,271,310,369,378],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":30},"Getting started","i-hugeicons-rocket-01","\u002Fen\u002Fgetting-started","en\u002F01.getting-started",[10,15,20,25],{"title":11,"path":12,"stem":13,"icon":14},"What is DDM?","\u002Fen\u002Fgetting-started\u002Fwhat-is-ddm","en\u002F01.getting-started\u002F01.what-is-ddm","i-hugeicons-information-circle",{"title":16,"path":17,"stem":18,"icon":19},"Account and sign-in","\u002Fen\u002Fgetting-started\u002Fsign-in","en\u002F01.getting-started\u002F02.sign-in","i-hugeicons-key-01",{"title":21,"path":22,"stem":23,"icon":24},"AI in DDM","\u002Fen\u002Fgetting-started\u002Fai-in-ddm","en\u002F01.getting-started\u002F03.ai-in-ddm","i-hugeicons-ai-magic",{"title":26,"path":27,"stem":28,"icon":29},"System status","\u002Fen\u002Fgetting-started\u002Fsystem-status","en\u002F01.getting-started\u002F04.system-status","i-hugeicons-activity-03",false,{"title":32,"icon":33,"path":34,"stem":35,"children":36,"page":30},"CMS","i-hugeicons-dashboard-square-01","\u002Fen\u002Fcms","en\u002F02.cms",[37,42,47,52,57,62,67,72,77,82,87,92,97,102,107,112],{"title":38,"path":39,"stem":40,"icon":41},"The CMS at a glance","\u002Fen\u002Fcms\u002Foverview","en\u002F02.cms\u002F01.overview","i-hugeicons-compass-01",{"title":43,"path":44,"stem":45,"icon":46},"Uploading documents","\u002Fen\u002Fcms\u002Fupload","en\u002F02.cms\u002F02.upload","i-hugeicons-upload-01",{"title":48,"path":49,"stem":50,"icon":51},"Categories","\u002Fen\u002Fcms\u002Fcategories","en\u002F02.cms\u002F03.categories","i-hugeicons-folder-tree",{"title":53,"path":54,"stem":55,"icon":56},"Editing documents","\u002Fen\u002Fcms\u002Fdocuments","en\u002F02.cms\u002F04.documents","i-hugeicons-file-edit",{"title":58,"path":59,"stem":60,"icon":61},"Searching and filtering","\u002Fen\u002Fcms\u002Fsearch-and-filters","en\u002F02.cms\u002F05.search-and-filters","i-hugeicons-search-01",{"title":63,"path":64,"stem":65,"icon":66},"Groups and permissions","\u002Fen\u002Fcms\u002Fgroups-and-permissions","en\u002F02.cms\u002F06.groups-and-permissions","i-hugeicons-user-multiple",{"title":68,"path":69,"stem":70,"icon":71},"Users","\u002Fen\u002Fcms\u002Fusers","en\u002F02.cms\u002F07.users","i-hugeicons-user-add-01",{"title":73,"path":74,"stem":75,"icon":76},"Approvals","\u002Fen\u002Fcms\u002Fapprovals","en\u002F02.cms\u002F08.approvals","i-hugeicons-checkmark-badge-01",{"title":78,"path":79,"stem":80,"icon":81},"Markets and translations","\u002Fen\u002Fcms\u002Fmarkets-and-translations","en\u002F02.cms\u002F09.markets-and-translations","i-hugeicons-globe-02",{"title":83,"path":84,"stem":85,"icon":86},"Note templates","\u002Fen\u002Fcms\u002Fnote-templates","en\u002F02.cms\u002F10.note-templates","i-hugeicons-layout-01",{"title":88,"path":89,"stem":90,"icon":91},"Usage and audit log","\u002Fen\u002Fcms\u002Fusage-and-audit","en\u002F02.cms\u002F11.usage-and-audit","i-hugeicons-chart-column",{"title":93,"path":94,"stem":95,"icon":96},"AI assistant","\u002Fen\u002Fcms\u002Fassistant","en\u002F02.cms\u002F12.assistant","i-hugeicons-sparkles",{"title":98,"path":99,"stem":100,"icon":101},"Settings","\u002Fen\u002Fcms\u002Fsettings","en\u002F02.cms\u002F13.settings","i-hugeicons-settings-02",{"title":103,"path":104,"stem":105,"icon":106},"Plans","\u002Fen\u002Fcms\u002Fplans","en\u002F02.cms\u002F14.plans","i-hugeicons-package",{"title":108,"path":109,"stem":110,"icon":111},"Feature requests","\u002Fen\u002Fcms\u002Ffeature-requests","en\u002F02.cms\u002F15.feature-requests","i-hugeicons-idea-01",{"title":113,"path":114,"stem":115,"icon":116},"Report a bug","\u002Fen\u002Fcms\u002Fbug-reports","en\u002F02.cms\u002F16.bug-reports","i-hugeicons-bug-01",{"title":118,"icon":119,"path":120,"stem":121,"children":122,"page":30},"App","i-hugeicons-smart-phone-01","\u002Fen\u002Fapp","en\u002F03.app",[123,128,133,138,143,147,152,157,162,167,170,173,176,179,184],{"title":124,"path":125,"stem":126,"icon":127},"Signing in and finding your way","\u002Fen\u002Fapp\u002Foverview","en\u002F03.app\u002F01.overview","i-hugeicons-login-03",{"title":129,"path":130,"stem":131,"icon":132},"Tabs and split view","\u002Fen\u002Fapp\u002Ftabs","en\u002F03.app\u002F02.tabs","i-hugeicons-layout-2-column",{"title":134,"path":135,"stem":136,"icon":137},"Finding and reading documents","\u002Fen\u002Fapp\u002Fdocuments","en\u002F03.app\u002F03.documents","i-hugeicons-file-01",{"title":139,"path":140,"stem":141,"icon":142},"Favorites","\u002Fen\u002Fapp\u002Ffavorites","en\u002F03.app\u002F04.favorites","i-hugeicons-favourite",{"title":144,"path":145,"stem":146,"icon":61},"Searching","\u002Fen\u002Fapp\u002Fsearch","en\u002F03.app\u002F05.search",{"title":148,"path":149,"stem":150,"icon":151},"Notes","\u002Fen\u002Fapp\u002Fnotes","en\u002F03.app\u002F06.notes","i-hugeicons-note-edit",{"title":153,"path":154,"stem":155,"icon":156},"Calendar and appointments","\u002Fen\u002Fapp\u002Fcalendar","en\u002F03.app\u002F07.calendar","i-hugeicons-calendar-03",{"title":158,"path":159,"stem":160,"icon":161},"Sending to customers","\u002Fen\u002Fapp\u002Foutbox","en\u002F03.app\u002F08.outbox","i-hugeicons-sent",{"title":163,"path":164,"stem":165,"icon":166},"Working offline","\u002Fen\u002Fapp\u002Foffline","en\u002F03.app\u002F09.offline","i-hugeicons-wifi-off-01",{"title":93,"path":168,"stem":169,"icon":96},"\u002Fen\u002Fapp\u002Fassistant","en\u002F03.app\u002F10.assistant",{"title":98,"path":171,"stem":172,"icon":101},"\u002Fen\u002Fapp\u002Fsettings","en\u002F03.app\u002F11.settings",{"title":108,"path":174,"stem":175,"icon":111},"\u002Fen\u002Fapp\u002Ffeature-requests","en\u002F03.app\u002F12.feature-requests",{"title":113,"path":177,"stem":178,"icon":116},"\u002Fen\u002Fapp\u002Fbug-reports","en\u002F03.app\u002F13.bug-reports",{"title":180,"path":181,"stem":182,"icon":183},"Desktop app","\u002Fen\u002Fapp\u002Fdesktop-app","en\u002F03.app\u002F14.desktop-app","i-hugeicons-computer",{"title":185,"path":186,"stem":187,"icon":119},"Mobile app","\u002Fen\u002Fapp\u002Fmobile-app","en\u002F03.app\u002F15.mobile-app",{"title":189,"icon":190,"path":191,"stem":192,"children":193,"page":30},"Sign-in & directories","i-hugeicons-security-check","\u002Fen\u002Fsign-in-and-directories","en\u002F04.sign-in-and-directories",[194,198,202,207,212,217,222,226,230,234],{"title":195,"path":196,"stem":197,"icon":19},"Sign-in methods","\u002Fen\u002Fsign-in-and-directories\u002Fsign-in-methods","en\u002F04.sign-in-and-directories\u002F01.sign-in-methods",{"title":199,"path":200,"stem":201,"icon":190},"Single sign-on","\u002Fen\u002Fsign-in-and-directories\u002Fsingle-sign-on","en\u002F04.sign-in-and-directories\u002F02.single-sign-on",{"title":203,"path":204,"stem":205,"icon":206},"Directory services (LDAP)","\u002Fen\u002Fsign-in-and-directories\u002Fdirectory-services","en\u002F04.sign-in-and-directories\u002F03.directory-services","i-hugeicons-hierarchy",{"title":208,"path":209,"stem":210,"icon":211},"Synchronisation and sign-in","\u002Fen\u002Fsign-in-and-directories\u002Fdirectory-sync","en\u002F04.sign-in-and-directories\u002F04.directory-sync","i-hugeicons-refresh",{"title":213,"path":214,"stem":215,"icon":216},"Microsoft Entra ID","\u002Fen\u002Fsign-in-and-directories\u002Fmicrosoft-entra-id","en\u002F04.sign-in-and-directories\u002F05.microsoft-entra-id","i-hugeicons-building-03",{"title":218,"path":219,"stem":220,"icon":221},"Okta","\u002Fen\u002Fsign-in-and-directories\u002Fokta","en\u002F04.sign-in-and-directories\u002F06.okta","i-hugeicons-finger-print",{"title":223,"path":224,"stem":225,"icon":81},"Google Workspace","\u002Fen\u002Fsign-in-and-directories\u002Fgoogle-workspace","en\u002F04.sign-in-and-directories\u002F07.google-workspace",{"title":227,"path":228,"stem":229,"icon":119},"Two-factor authentication","\u002Fen\u002Fsign-in-and-directories\u002Ftwo-factor-authentication","en\u002F04.sign-in-and-directories\u002F08.two-factor-authentication",{"title":231,"path":232,"stem":233,"icon":221},"Passkeys","\u002Fen\u002Fsign-in-and-directories\u002Fpasskeys","en\u002F04.sign-in-and-directories\u002F09.passkeys",{"title":235,"path":236,"stem":237,"icon":156},"Calendar access","\u002Fen\u002Fsign-in-and-directories\u002Fcalendar-access","en\u002F04.sign-in-and-directories\u002F10.calendar-access",{"title":239,"icon":240,"path":241,"stem":242,"children":243,"page":30},"MCP server","i-hugeicons-ai-network","\u002Fen\u002Fmcp-server","en\u002F05.mcp-server",[244,248,253,257,262,266],{"title":245,"path":246,"stem":247,"icon":240},"Overview","\u002Fen\u002Fmcp-server\u002Foverview","en\u002F05.mcp-server\u002F01.overview",{"title":249,"path":250,"stem":251,"icon":252},"Setup","\u002Fen\u002Fmcp-server\u002Fsetup","en\u002F05.mcp-server\u002F02.setup","i-hugeicons-plug-socket",{"title":254,"path":255,"stem":256,"icon":111},"What you can do with it","\u002Fen\u002Fmcp-server\u002Fuse-cases","en\u002F05.mcp-server\u002F03.use-cases",{"title":258,"path":259,"stem":260,"icon":261},"Tools","\u002Fen\u002Fmcp-server\u002Ftools","en\u002F05.mcp-server\u002F04.tools","i-hugeicons-wrench-01",{"title":263,"path":264,"stem":265,"icon":76},"Approving changes","\u002Fen\u002Fmcp-server\u002Fapproving-changes","en\u002F05.mcp-server\u002F05.approving-changes",{"title":267,"path":268,"stem":269,"icon":270},"Administration & security","\u002Fen\u002Fmcp-server\u002Fadmin-and-security","en\u002F05.mcp-server\u002F06.admin-and-security","i-hugeicons-shield-key",{"title":272,"icon":273,"path":274,"stem":275,"children":276,"page":30},"External sources","i-hugeicons-database-sync","\u002Fen\u002Fexternal-sources","en\u002F06.external-sources",[277,280,285,290,295,300,305],{"title":245,"path":278,"stem":279,"icon":273},"\u002Fen\u002Fexternal-sources\u002Foverview","en\u002F06.external-sources\u002F01.overview",{"title":281,"path":282,"stem":283,"icon":284},"SharePoint","\u002Fen\u002Fexternal-sources\u002Fsharepoint","en\u002F06.external-sources\u002F02.sharepoint","i-hugeicons-microsoft",{"title":286,"path":287,"stem":288,"icon":289},"OneDrive","\u002Fen\u002Fexternal-sources\u002Fonedrive","en\u002F06.external-sources\u002F03.onedrive","i-hugeicons-folder-cloud",{"title":291,"path":292,"stem":293,"icon":294},"Google Drive","\u002Fen\u002Fexternal-sources\u002Fgoogle-drive","en\u002F06.external-sources\u002F04.google-drive","i-hugeicons-google-drive",{"title":296,"path":297,"stem":298,"icon":299},"FTP \u002F SFTP","\u002Fen\u002Fexternal-sources\u002Fftp-sftp","en\u002F06.external-sources\u002F05.ftp-sftp","i-hugeicons-server-stack-01",{"title":301,"path":302,"stem":303,"icon":304},"REST interface","\u002Fen\u002Fexternal-sources\u002Frest","en\u002F06.external-sources\u002F06.rest","i-hugeicons-api",{"title":306,"path":307,"stem":308,"icon":309},"SOAP interface","\u002Fen\u002Fexternal-sources\u002Fsoap","en\u002F06.external-sources\u002F07.soap","i-hugeicons-source-code",{"title":311,"icon":304,"path":312,"stem":313,"children":314,"page":30},"Integration API","\u002Fen\u002Fintegration-api","en\u002F07.integration-api",[315,318,322,327,332,337,341,346,350,354,359,364],{"title":245,"path":316,"stem":317,"icon":14},"\u002Fen\u002Fintegration-api\u002Foverview","en\u002F07.integration-api\u002F01.overview",{"title":319,"path":320,"stem":321,"icon":19},"Authentication","\u002Fen\u002Fintegration-api\u002Fauthentication","en\u002F07.integration-api\u002F02.authentication",{"title":323,"path":324,"stem":325,"icon":326},"Conventions","\u002Fen\u002Fintegration-api\u002Fconventions","en\u002F07.integration-api\u002F03.conventions","i-hugeicons-book-open-01",{"title":328,"path":329,"stem":330,"icon":331},"Pushing documents","\u002Fen\u002Fintegration-api\u002Fpushing-documents","en\u002F07.integration-api\u002F04.pushing-documents","i-hugeicons-upload-02",{"title":333,"path":334,"stem":335,"icon":336},"Consuming content","\u002Fen\u002Fintegration-api\u002Fconsuming-content","en\u002F07.integration-api\u002F05.consuming-content","i-hugeicons-download-02",{"title":338,"path":339,"stem":340,"icon":137},"Reference: documents","\u002Fen\u002Fintegration-api\u002Freference-documents","en\u002F07.integration-api\u002F06.reference-documents",{"title":342,"path":343,"stem":344,"icon":345},"Reference: categories, tags, markets","\u002Fen\u002Fintegration-api\u002Freference-categories-tags","en\u002F07.integration-api\u002F07.reference-categories-tags","i-hugeicons-folder-01",{"title":347,"path":348,"stem":349,"icon":211},"Reference: sync manifest","\u002Fen\u002Fintegration-api\u002Freference-sync","en\u002F07.integration-api\u002F08.reference-sync",{"title":351,"path":352,"stem":353,"icon":309},"OpenAPI","\u002Fen\u002Fintegration-api\u002Fopenapi","en\u002F07.integration-api\u002F09.openapi",{"title":355,"path":356,"stem":357,"icon":358},"Changelog","\u002Fen\u002Fintegration-api\u002Fchangelog","en\u002F07.integration-api\u002F10.changelog","i-hugeicons-time-schedule",{"title":360,"path":361,"stem":362,"icon":363},"Reference: groups, markets, access","\u002Fen\u002Fintegration-api\u002Freference-groups-access","en\u002F07.integration-api\u002F11.reference-groups-access","i-hugeicons-user-lock-01",{"title":365,"path":366,"stem":367,"icon":368},"Moving from CMWS","\u002Fen\u002Fintegration-api\u002Fcmws","en\u002F07.integration-api\u002F12.cmws","i-hugeicons-arrow-reload-horizontal",{"title":370,"icon":371,"path":372,"stem":373,"children":374,"page":30},"What's new","i-hugeicons-gift","\u002Fen\u002Fwhats-new","en\u002F08.whats-new",[375],{"title":355,"path":376,"stem":377,"icon":358},"\u002Fen\u002Fwhats-new\u002Fchangelog","en\u002F08.whats-new\u002F01.changelog",{"title":379,"icon":299,"path":380,"stem":381,"children":382,"page":30},"Self-hosting","\u002Fen\u002Fself-hosting","en\u002F09.self-hosting",[383,386,390,395,399,404,408,413,418,422],{"title":245,"path":384,"stem":385,"icon":14},"\u002Fen\u002Fself-hosting\u002Foverview","en\u002F09.self-hosting\u002F01.overview",{"title":387,"path":388,"stem":389,"icon":106},"Docker Compose","\u002Fen\u002Fself-hosting\u002Fdocker-compose","en\u002F09.self-hosting\u002F02.docker-compose",{"title":391,"path":392,"stem":393,"icon":394},"Kubernetes","\u002Fen\u002Fself-hosting\u002Fkubernetes","en\u002F09.self-hosting\u002F03.kubernetes","i-hugeicons-cloud",{"title":396,"path":397,"stem":398,"icon":101},"Configuration","\u002Fen\u002Fself-hosting\u002Fconfiguration","en\u002F09.self-hosting\u002F04.configuration",{"title":400,"path":401,"stem":402,"icon":403},"Licence","\u002Fen\u002Fself-hosting\u002Flicence","en\u002F09.self-hosting\u002F05.licence","i-hugeicons-license",{"title":405,"path":406,"stem":407,"icon":211},"Updates","\u002Fen\u002Fself-hosting\u002Fupdates","en\u002F09.self-hosting\u002F06.updates",{"title":409,"path":410,"stem":411,"icon":412},"Postgres","\u002Fen\u002Fself-hosting\u002Fpostgres","en\u002F09.self-hosting\u002F07.postgres","i-hugeicons-database",{"title":414,"path":415,"stem":416,"icon":417},"Backups","\u002Fen\u002Fself-hosting\u002Fbackups","en\u002F09.self-hosting\u002F08.backups","i-hugeicons-database-restore",{"title":419,"path":420,"stem":421,"icon":261},"Troubleshooting","\u002Fen\u002Fself-hosting\u002Ftroubleshooting","en\u002F09.self-hosting\u002F09.troubleshooting",{"title":423,"path":424,"stem":425,"icon":426},"Firewall","\u002Fen\u002Fself-hosting\u002Ffirewall","en\u002F09.self-hosting\u002F10.firewall","i-hugeicons-firewall",{"id":428,"title":245,"body":429,"description":950,"extension":951,"links":952,"meta":953,"navigation":954,"path":316,"seo":955,"stem":317,"__hash__":956},"docs_en\u002Fen\u002F07.integration-api\u002F01.overview.md",{"type":430,"value":431,"toc":944},"minimark",[432,451,454,503,514,525,530,592,596,850,854,912,915,919,940],[433,434,435,436,440,441,445,446,450],"p",{},"DDM's built-in ",[437,438,439],"a",{"href":278},"external sources"," ",[442,443,444],"em",{},"fetch"," documents from SharePoint, Google Drive, OneDrive, FTP or an HTTP interface. Some systems have no built-in connector: a PIM, an ERP, a DMS, your own application. For those there is the ",[447,448,449],"strong",{},"integration API",". It is an HTTP\u002FJSON interface that your developers, or the developers of the other system, call themselves.",[433,452,453],{},"It works in two directions:",[455,456,457,473],"table",{},[458,459,460],"thead",{},[461,462,463,467,470],"tr",{},[464,465,466],"th",{},"Direction",[464,468,469],{},"What another system does",[464,471,472],{},"Typical use",[474,475,476,490],"tbody",{},[461,477,478,484,487],{},[479,480,481],"td",{},[447,482,483],{},"Push",[479,485,486],{},"Sends documents to DDM, and creates, changes and deletes them along with their categories, tags and titles",[479,488,489],{},"A PIM pushes every data sheet as a PDF after each release",[461,491,492,497,500],{},[479,493,494],{},[447,495,496],{},"Consume",[479,498,499],{},"Reads documents, categories and files from DDM",[479,501,502],{},"A script copies all released price lists to the website every night",[504,505,506,507,510,511,513],"note",{},"Available from the ",[447,508,509],{},"Professional"," plan – see ",[437,512,103],{"href":104},".",[515,516,517,518,522,523,513],"tip",{},"Coming from the old DDM? Its CMWS interface keeps working at ",[519,520,521],"code",{},"\u002Fapi\u002Fcmws\u002Fv1"," with your old keys – see ",[437,524,365],{"href":366},[526,527,529],"h2",{"id":528},"the-basics","The basics",[531,532,533,547,556,572,582],"ul",{},[534,535,536,440,539,542,543,546],"li",{},[447,537,538],{},"Address:",[519,540,541],{},"https:\u002F\u002F\u003Cyour CMS address>\u002Fapi\u002Fext\u002Fv1",". Settings › ",[447,544,545],{},"API access"," shows the exact address and has a copy button.",[534,548,549,552,553,513],{},[447,550,551],{},"Format:"," JSON. Files are uploaded as ",[519,554,555],{},"multipart\u002Fform-data",[534,557,558,561,562,565,566,569,570,513],{},[447,559,560],{},"Authentication:"," with an ",[447,563,564],{},"API key",", sent as ",[519,567,568],{},"Authorization: Bearer ddm_…",". See ",[437,571,319],{"href":320},[534,573,574,577,578,581],{},[447,575,576],{},"Permissions:"," a key acts as ",[447,579,580],{},"one person"," in your organisation and has exactly that person's permissions. It can see and change exactly what that person can see and change in the CMS.",[534,583,584,587,588,591],{},[447,585,586],{},"Reference:"," the complete description is an ",[437,589,590],{"href":352},"OpenAPI document",". You can import it into Postman, Insomnia or a client generator.",[526,593,595],{"id":594},"a-first-request","A first request",[597,598,599,648,780,832],"code-group",{},[600,601,607],"pre",{"className":602,"code":603,"filename":604,"language":605,"meta":606,"style":606},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl https:\u002F\u002Fddm.example.com\u002Fapi\u002Fext\u002Fv1\u002Fdocuments?limit=5 \\\n  -H \"Authorization: Bearer $DDM_API_KEY\"\n","curl","bash","",[519,608,609,629],{"__ignoreMap":606},[610,611,614,617,621,625],"span",{"class":612,"line":613},"line",1,[610,615,604],{"class":616},"sBMFI",[610,618,620],{"class":619},"sfazB"," https:\u002F\u002Fddm.example.com\u002Fapi\u002Fext\u002Fv1\u002Fdocuments?limit=",[610,622,624],{"class":623},"sbssI","5",[610,626,628],{"class":627},"sTEyZ"," \\\n",[610,630,632,635,639,642,645],{"class":612,"line":631},2,[610,633,634],{"class":619},"  -H",[610,636,638],{"class":637},"sMK4o"," \"",[610,640,641],{"class":619},"Authorization: Bearer ",[610,643,644],{"class":627},"$DDM_API_KEY",[610,646,647],{"class":637},"\"\n",[600,649,654],{"className":650,"code":651,"filename":652,"language":653,"meta":606,"style":606},"language-js shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","const response = await fetch('https:\u002F\u002Fddm.example.com\u002Fapi\u002Fext\u002Fv1\u002Fdocuments?limit=5', {\n  headers: { Authorization: `Bearer ${process.env.DDM_API_KEY}` }\n})\nconst { data, nextCursor } = await response.json()\n","JavaScript","js",[519,655,656,693,738,747],{"__ignoreMap":606},[610,657,658,662,665,668,672,676,679,682,685,687,690],{"class":612,"line":613},[610,659,661],{"class":660},"spNyl","const",[610,663,664],{"class":627}," response ",[610,666,667],{"class":637},"=",[610,669,671],{"class":670},"s7zQu"," await",[610,673,675],{"class":674},"s2Zo4"," fetch",[610,677,678],{"class":627},"(",[610,680,681],{"class":637},"'",[610,683,684],{"class":619},"https:\u002F\u002Fddm.example.com\u002Fapi\u002Fext\u002Fv1\u002Fdocuments?limit=5",[610,686,681],{"class":637},[610,688,689],{"class":637},",",[610,691,692],{"class":637}," {\n",[610,694,695,699,702,705,708,710,713,716,719,722,724,727,729,732,735],{"class":612,"line":631},[610,696,698],{"class":697},"swJcz","  headers",[610,700,701],{"class":637},":",[610,703,704],{"class":637}," {",[610,706,707],{"class":697}," Authorization",[610,709,701],{"class":637},[610,711,712],{"class":637}," `",[610,714,715],{"class":619},"Bearer ",[610,717,718],{"class":637},"${",[610,720,721],{"class":627},"process",[610,723,513],{"class":637},[610,725,726],{"class":627},"env",[610,728,513],{"class":637},[610,730,731],{"class":627},"DDM_API_KEY",[610,733,734],{"class":637},"}`",[610,736,737],{"class":637}," }\n",[610,739,741,744],{"class":612,"line":740},3,[610,742,743],{"class":637},"}",[610,745,746],{"class":627},")\n",[610,748,750,752,754,757,759,762,764,767,769,772,774,777],{"class":612,"line":749},4,[610,751,661],{"class":660},[610,753,704],{"class":637},[610,755,756],{"class":627}," data",[610,758,689],{"class":637},[610,760,761],{"class":627}," nextCursor ",[610,763,743],{"class":637},[610,765,766],{"class":637}," =",[610,768,671],{"class":670},[610,770,771],{"class":627}," response",[610,773,513],{"class":637},[610,775,776],{"class":674},"json",[610,778,779],{"class":627},"()\n",[600,781,786],{"className":782,"code":783,"filename":784,"language":785,"meta":606,"style":606},"language-python shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import os, requests\n\nresponse = requests.get(\n    \"https:\u002F\u002Fddm.example.com\u002Fapi\u002Fext\u002Fv1\u002Fdocuments\",\n    params={\"limit\": 5},\n    headers={\"Authorization\": f\"Bearer {os.environ['DDM_API_KEY']}\"},\n)\npage = response.json()\n","Python","python",[519,787,788,793,799,804,809,815,821,826],{"__ignoreMap":606},[610,789,790],{"class":612,"line":613},[610,791,792],{},"import os, requests\n",[610,794,795],{"class":612,"line":631},[610,796,798],{"emptyLinePlaceholder":797},true,"\n",[610,800,801],{"class":612,"line":740},[610,802,803],{},"response = requests.get(\n",[610,805,806],{"class":612,"line":749},[610,807,808],{},"    \"https:\u002F\u002Fddm.example.com\u002Fapi\u002Fext\u002Fv1\u002Fdocuments\",\n",[610,810,812],{"class":612,"line":811},5,[610,813,814],{},"    params={\"limit\": 5},\n",[610,816,818],{"class":612,"line":817},6,[610,819,820],{},"    headers={\"Authorization\": f\"Bearer {os.environ['DDM_API_KEY']}\"},\n",[610,822,824],{"class":612,"line":823},7,[610,825,746],{},[610,827,829],{"class":612,"line":828},8,[610,830,831],{},"page = response.json()\n",[600,833,838],{"className":834,"code":835,"filename":836,"language":837,"meta":606,"style":606},"language-powershell shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","$headers = @{ Authorization = \"Bearer $env:DDM_API_KEY\" }\nInvoke-RestMethod -Uri \"https:\u002F\u002Fddm.example.com\u002Fapi\u002Fext\u002Fv1\u002Fdocuments?limit=5\" -Headers $headers\n","PowerShell","powershell",[519,839,840,845],{"__ignoreMap":606},[610,841,842],{"class":612,"line":613},[610,843,844],{},"$headers = @{ Authorization = \"Bearer $env:DDM_API_KEY\" }\n",[610,846,847],{"class":612,"line":631},[610,848,849],{},"Invoke-RestMethod -Uri \"https:\u002F\u002Fddm.example.com\u002Fapi\u002Fext\u002Fv1\u002Fdocuments?limit=5\" -Headers $headers\n",[526,851,853],{"id":852},"connector-or-api","Connector or API?",[455,855,856,867],{},[458,857,858],{},[461,859,860,862,865],{},[464,861],{},[464,863,864],{},"Built-in connector",[464,866,311],{},[474,868,869,880,890,901],{},[461,870,871,874,877],{},[479,872,873],{},"Who does the work",[479,875,876],{},"DDM fetches on a schedule",[479,878,879],{},"The other system calls DDM",[461,881,882,884,887],{},[479,883,249],{},[479,885,886],{},"Settings only",[479,888,889],{},"Somebody writes the calls",[461,891,892,895,898],{},[479,893,894],{},"When a change arrives",[479,896,897],{},"At the next sync",[479,899,900],{},"As soon as the other system sends it",[461,902,903,906,909],{},[479,904,905],{},"Taking content out of DDM",[479,907,908],{},"–",[479,910,911],{},"Yes",[433,913,914],{},"If DDM already has a connector for your system, use the connector. Use the API when there is none, when changes have to arrive immediately, or when content has to go from DDM into another system.",[526,916,918],{"id":917},"stability","Stability",[433,920,921,922,925,926,929,930,933,934,936,937,513],{},"Within ",[519,923,924],{},"v1",", changes are only additions: new endpoints, new optional fields, new fields in responses. Existing fields keep their names and meaning. A program should ",[447,927,928],{},"ignore fields it does not know",". A breaking change would come as ",[519,931,932],{},"v2",", running alongside ",[519,935,924],{},". All changes are listed in the ",[437,938,939],{"href":356},"changelog",[941,942,943],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}",{"title":606,"searchDepth":631,"depth":631,"links":945},[946,947,948,949],{"id":528,"depth":631,"text":529},{"id":594,"depth":631,"text":595},{"id":852,"depth":631,"text":853},{"id":917,"depth":631,"text":918},"The external API connects DDM to systems we have no connector for – to push documents in, and to take content out.","md",null,{},{"icon":14},{"title":245,"description":950},"BjcEETQiqc5Owa4ZZ9tB-VIAWeJc_-TOlndtQK1MXsw",[958,960],{"title":306,"path":307,"stem":308,"description":959,"icon":309,"children":-1},"Take over documents from a system with a SOAP web service – with a request chain, XML paths and a field mapping.",{"title":319,"path":320,"stem":321,"description":961,"icon":19,"children":-1},"API keys – creating them, what they may do, as whom they act, and keeping them safe.",1793617721667]