https://docs.coalesce.io/assets/js/c0d99854.2207bcef.js

1"use strict";(globalThis.webpackChunkcoalesce_docs=globalThis.webpackChunkcoalesce_docs||[]).push([[13175],{76723(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/using-the-api-explorer","title":"Using the API Explorer","description":"Navigate the Coalesce API Explorer for interactive API testing and documentation. Explore endpoints, test requests, review responses, and generate code samples across multiple programming languages with built-in API interface.","source":"@site/docs/api/using-the-api-explorer.md","sourceDirName":"api","slug":"/api/using-the-api-explorer","permalink":"/docs/api/using-the-api-explorer","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"Using the API Explorer","description":"Navigate the Coalesce API Explorer for interactive API testing and documentation. Explore endpoints, test requests, review responses, and generate code samples across multiple programming languages with built-in API interface.","keywords":["API Explorer","Coalesce API testing","interactive API","API documentation","API interface","code samples","API endpoints","API testing tool","API responses","API request builder"]},"sidebar":"apiSidebar","previous":{"title":"Making Your First Request","permalink":"/docs/api/making-your-first-api-request"},"next":{"title":"Query Parameters","permalink":"/docs/api/query-parameters"}}');var i=t(74848),a=t(28453);const r={title:"Using the API Explorer",description:"Navigate the Coalesce API Explorer for interactive API testing and documentation. Explore endpoints, test requests, review responses, and generate code samples across multiple programming languages with built-in API interface.",keywords:["API Explorer","Coalesce API testing","interactive API","API documentation","API interface","code samples","API endpoints","API testing tool","API responses","API request builder"]},o=void 0,l={},c=[{value:"API Menu",id:"api-menu",level:2},{value:"API Details",id:"api-details",level:2},{value:"API Request",id:"api-request",level:2}];function d(e){const n={a:"a",admonition:"admonition",h2:"h2",li:"li",ol:"ol",p:"p",ul:"ul",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"The API explorer is divided into three parts:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"API menu"}),"\n",(0,i.jsx)(n.li,{children:"API details"}),"\n",(0,i.jsx)(n.li,{children:"API request"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"api-menu",children:"API Menu"}),"\n",(0,i.jsx)(n.p,{children:"Use the menu to navigate between the different endpoints. Each point will list the request type next to the name."}),"\n",(0,i.jsx)("img",{src:"/img/docs-images/api/api_menu.png",alt:"Coalesce API Menu",className:"mdImages",width:"40%"}),"\n",(0,i.jsx)(n.h2,{id:"api-details",children:"API Details"}),"\n",(0,i.jsx)(n.p,{children:"The API details contains the API name, endpoint, and any parameters required to make the request, and responses. An example of the response and schema can be found by toggling between Schema and the Response name."}),"\n",(0,i.jsx)("img",{src:"/img/docs-images/api/api_details.png",alt:"Coalesce API details",className:"mdImages",width:"60%"}),"\n",(0,i.jsx)(n.h2,{id:"api-request",children:"API Request"}),"\n",(0,i.jsx)(n.p,{children:"The API request contains code samples in multiple languages. Select your language from the options above the code sample and copy to start using it in your code. It also contains the Request and Response section."}),"\n",(0,i.jsx)(n.p,{children:"To make a request:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Edit the Base URL to match yours."}),"\n",(0,i.jsxs)(n.li,{children:["Enter your ",(0,i.jsx)(n.a,{href:"/docs/api/authentication",children:"Access Token"})," in Bearer Token."]}),"\n",(0,i.jsx)(n.li,{children:"Add in any optional parameters and edit the request body."}),"\n",(0,i.jsx)(n.li,{children:"Click Send API Request."}),"\n",(0,i.jsx)(n.li,{children:"Then review your response in the Response area."}),"\n"]}),"\n",(0,i.jsx)("img",{src:"/img/docs-images/api/api_explorer_example.png",alt:"API request example",className:"mdImages",width:"50%"}),"\n",(0,i.jsx)(n.admonition,{title:"Jobs API",type:"warning",children:(0,i.jsx)(n.p,{children:"Making a request is not available for the Jobs API."})})]})}function p(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},28453(e,n,t){t.d(n,{R:()=>r,x:()=>o});var s=t(96540);const i={},a=s.createContext(i);function r(e){const n=s.useContext(a);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]);