{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9976722b-ff74-4fa9-b196-59cf63d85151","name":"doinstruct","description":"\n\n## Introduction / Einführung\n\n| **English** | **Deutsch** |\n| --- | --- |\n| The doinstruct API is a JSON API that is used both for server-to-server communication and for the doinstruct content management system. | Die doinstruct API ist eine JSON-API, die sowohl für die Server zu Server Kommunikation genutzt wird als auch für das doinstruct Content Management System. |\n\n## Authentication / Authentifizierung\n\n| **English** | **Deutsch** |\n| --- | --- |\n| To get access to the API, you will receive an API key from doinstruct. The API key must be sent with every request as the \"X-API-KEY\" header. Furthermore, a user with an e-mail address and a password is required. You can use this access data to log in against the API. As a response to the login, you will receive a bearer token, which you must send as an \"authentication\" header for all further requests. The lifetime of the token is also included in the response.

Please save all access data securely and access-protected. The access data should not be shared with third parties. | Um Zugriff auf die API zu bekommen, erhalten Sie von doinstruct einen API Key. Dieser muss bei jeder Anfrage als Header \"X-API-KEY\" mitgesendet werden. Weiterhin ist ein Benutzer mit einer E-Mail-Adresse und einem Password nötig. Mit diesen Zugangsdaten kann man sich gegen die API einloggen. Als Antwort des Logins erhalten Sie einen Bearer-Token, den Sie bei allen weiteren Anfragen als \"authentication\"-Header mitsenden müssen. Die Gültigkeitsdauer des Tokens ist ebenfalls im Response enthalten.

Bitte speichern Sie alle Zugangsdaten sicher und zugriffsgeschützt ab. Die Zugangsdaten sollen nicht mit dritten geteilt werden. |\n\n## Domains\n\n| **Environment** | **Domain** |\n| --- | --- |\n| Live | cms-api.doinstruct.com |\n\n## Headers\n\n| **Name** | **Value** | **Description** |\n| --- | --- | --- |\n| Accept-Encoding | gzip, deflate, br | Optional, but recommended. For content compression. |\n| Authorization | Token from the response of the /auth/sign-in call | The \"Authorization\" header must be set on all requests. Except all endpoints of the Auth-API. |\n| Content-Type | application/json | The Content-Type header must be set for all POST, PATCH and PUT requests. |\n| X-API-Key | A valide api key | Required. The api key is issued by doinstruct |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"23138434","team":3163101,"collectionId":"9976722b-ff74-4fa9-b196-59cf63d85151","publishedId":"2s93CUGpmv","public":true,"publicUrl":"https://docs-api.doinstruct.com","privateUrl":"https://go.postman.co/documentation/23138434-9976722b-ff74-4fa9-b196-59cf63d85151","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FFA748"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-03-06T09:38:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"cms - live","id":"6bd1c79d-07de-46ee-b95c-b7fa99af7201","owner":"23138434","values":[{"key":"baseUrl","value":"https://cms-api.doinstruct.com","enabled":true,"type":"default"},{"key":"token","value":"","enabled":true,"type":"secret"},{"key":"refreshToken","value":"","enabled":true,"type":"secret"},{"key":"username","value":"","enabled":true,"type":"secret"},{"key":"clientId","value":"","enabled":true,"type":"default"},{"key":"email","value":"","enabled":true,"type":"secret"},{"key":"password","value":"","enabled":true,"type":"secret"},{"key":"resetPasswordToken","value":"","enabled":true,"type":"default"},{"key":"employeeId","value":"","enabled":true,"type":"default"},{"key":"jobId","value":"","enabled":true,"type":"default"},{"key":"apiKey","value":"","enabled":true,"type":"secret"},{"key":"mediaBaseUrl","value":"https://media.doinstruct.com","enabled":true,"type":"default"},{"key":"websocketBaseUrl","value":"wss://wss.doinstruct.com","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/32e844275069be9cb3a981294a21df9937623fcf889c8ac7ee5dbb97c8ee6152","favicon":"https://doinstruct.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"cms - live","value":"23138434-6bd1c79d-07de-46ee-b95c-b7fa99af7201"}],"canonicalUrl":"https://docs-api.doinstruct.com/view/metadata/2s93CUGpmv"}