\n Generate a fully typed client for your Occtoo Destination API.\n
\n\n
Occtoo
\n\nOcctoo is an Experience Data Platform designed to accelerate the way companies create meaningful customer experiences across various touchpoints. Our platform is tailored to assist digital officers, marketers, and developers in transitioning to a new paradigm where they can dedicate less time to data integration and more time to unleashing their creative potential with data.\n\nAn Occtoo Destination offers one or more endpoints that allow you to query specific subsets of your data. It also encompasses facets and various mechanisms for fine-tuning queries by leveraging them.\n\nFor more in-depth information about how to query a destination, please refer to the [destination docs](https://docs.occtoo.com/docs/get-started/call-custom-destination/).\n\n
Getting started
\n\nFirst, put your Occtoo Destination values in a `.env` file:\n\n```bash\nOCCTOO_DESTINATION_ID=...\nOCCTOO_DESTINATION_URL=...\n```\n\nFor demo purposes, you can use the following URL as OCCTOO_DESTINATION_URL:\n\n```\nhttps://global.occtoo.com/occtoodemo/occtooFrontEndDocumentation/v3\n```\n\nThen, install the package:\n\n```bash\nnpm install @occtoo/destination-client\n```\n\nLastly, import the `DestinationClient` class to create a new destination client and use it to query your destination endpoints. Using a RSC in Next.js, for example:\n\n```javascript\nimport Image from \"next/image\";\n\n// import the destination client\nimport { DestinationClient } from \"@occtoo/destination-client\";\n\nconst getProducts = async () => {\n // create a new destination client\n const destinationClient = new DestinationClient();\n\n // fetch data from destination\n const destinationResponse = await destinationClient.post(\"/products\", {\n filter: [\n {\n must: {\n category: [\"Pants\"],\n },\n },\n ],\n sortAsc: [\"id\"],\n skip: 0,\n top: 14,\n });\n\n return destinationResponse;\n};\n\nexport default async function ProductsComponent() {\n const products = await getProducts();\n\n return (\n
\n {products.results?.map((product) => (\n \n
\n {product.urls?.length && (\n \n )}\n
\n
{product.name}
\n
\n ))}\n \n );\n}\n```\n\n
Authentication
\n\nIf you are using a protected destination, you can pass client credentials to the `DestinationClient`.\nCredentials can be generated in the Occtoo Studio.\n\nNote: If you are using an unprotected (public) destination, you can skip these steps.\n\n```javascript\nconst destinationClient = new DestinationClient({\n credentials: {\n clientId: process.env.DESTINATION_APP_ID,\n clientSecret: process.env.DESTINATION_APP_SECRET,\n },\n});\n```\n\nThen call the `authenticate` method to authenticate the client before making any requests:\n\n```javascript\nawait destinationClient.authenticate();\n```\n\nNote: Authentication is only permitted server-side. Tokens and credentials should be stored securely and not exposed to unauthorized clients.\n\nYou can also pass an access token directly to the client (returned by the `authenticate` method):\n\n```javascript\nconst destinationClient = new DestinationClient({\n headers: {\n Authorization: \"Bearer \",\n },\n});\n```\n\n
Regenerate the client
\nIf your destination has been updated and you want to regenerate the client, you can update the client by updating your `.env` file and running the following command:\n\n```bash\nnpx @occtoo/destination-client generate\n```\n\n#### Links\n\n- [Occtoo docs](https://docs.occtoo.com/)\n- [Occtoo website](https://www.occtoo.com/)\n","readmeFilename":"README.md"}
![](\"https://6519008.fs1.hubspotusercontent-na1.net/hub/6519008/hubfs/Logo-Occtoo-white.png?width=200&height=80&name=Logo-Occtoo-white.png\"){kind=logo}