{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/custom-cards/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Authorization","description":"Start building with the Dixa API","siteUrl":"https://docs.dixa.io/","keywords":"dixa developer hub, api portal starter, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"authorization","__idx":0},"children":["Authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You don't get to choose the authorization method, it is defined by the endpoint. When you look at the endpoint documentation, you can normally find a section called authorization or authentication. You can look for a page called authentication or authorization. Custom cards support the default 'Authorization' header or custom headers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/auth-methods.c0d03e27bdfeb7123af11ab76aca7f6d37c248d6db6e9675e9fee2c2281472a3.fcd6b147.png","alt":""},"children":[]},"Showing the choice between OAuth or Authorization header."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authorization-header","__idx":1},"children":["Authorization header"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorization header"]},", you must choose either ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Basic, Baerer,"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom"]}," in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorization header"]}," dropdown**.**"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Basic"]}," authorization, you will be asked to provide the user and password required for the 3rd party API (the information will be encoded in base64 and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://en.wikipedia.org/wiki/Basic_access_authentication"},"children":["passed to the 3rd party"]},").",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/basic.de63b1dbb5758c5debb05ce34a49b3ba3969daa7bd35e68372d725a17d640bc8.fcd6b147.png","alt":"Basic Authorization in Dixa"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bearer"]}," authorization type, then you will be required to specify the token from the third-party API (the information ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://swagger.io/docs/specification/authentication/bearer-authentication/"},"children":["will be passed with the Bearer prefix"]},")",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/bearer.d08941ba19526237070e08764fe19acc703a981e24879dbb1efc21f9196ca377.fcd6b147.png","alt":"Bearer Authorization in Dixa"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom"]}," Authorization type, you can specify the prefix to be used inside the Authorization header.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/custom.00130e0df9be2d7047d627b639f2b56cfe562eec003d66a20a006d71433a08ad.fcd6b147.png","alt":"Custom Authorization in Dixa"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"custom-header","__idx":2},"children":["Custom header"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the API you are connecting to requires additional or alternative headers (like ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["x-api-key"]}," for an Amazon-hosted system), then you can use the Custom Header option to add additional key-value headers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/custom-header.5b3c728927419db186dbed413b40f2f9a5fd558807c265a0b3c5995c271686dd.fcd6b147.png","alt":"Custom Headers in Dixa"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Depending on your system's authorisation needs, custom headers can be used in addition or as a replacement for Authorization headers."]}]},"headings":[{"value":"Authorization","id":"authorization","depth":1},{"value":"Authorization header","id":"authorization-header","depth":2},{"value":"Custom header","id":"custom-header","depth":2}],"frontmatter":{"seo":{"title":"Authorization"}},"lastModified":"2026-04-09T11:32:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/custom-cards/authorization","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}