@occtoo/destination-client

@occtoo/destination-client

Generate a fully typed client library for Occtoo Destination APIs.

Get started by running npm install @occtoo/destination-client

Occtoo

Occtoo 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.

An 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.

For more in-depth information about how to query a destination, please refer to the destination docs.

Installation and Usage

First, put your Occtoo destination values in a .env file:

OCCTOO_DESTINATION_ID=...
OCCTOO_DESTINATION_URL=...

Install the package:

npm install @occtoo/destination-client

Then, import the DestinationClient class to create a new destination client and use it to query your destination endpoints:

import { DestinationClient } from "@occtoo/destination-client";
import Image from "next/image";

const getProducts = async () => {
  // create a new destination client
  const destination = new DestinationClient({
    credentials: {
      clientId: "...",
      clientSecret: "...",
    },
  });

  // fetch access token if using a protected destination
  await destination.authenticate();

  // fetch data from destination
  const destinationResponse = await destination.post("/product", {
    top: 10,
    filter: [
      {
        must: {
          lineKey: ["WATCH"],
          collectionKey: ["CARWMFTANK"],
        },
      },
    ],
    sortAsc: ["id"],
  });

  return destinationResponse;
};

export default async function DestinationProducts() {
  const products = await getProducts();

  return (
    <div className="container flex flex-row flex-wrap">
      {products.results?.map((product) => (
        <div
          key={product.id}
          className="flex flex-col items-center justify-center w-[200px] shrink-0 h-[250px] border"
        >
          <div className="flex items-center justify-center h-full">
            {product.images?.length && (
              <Image
                src={product.images?.find((i) => i.url)?.url + "?format=small"}
                alt={product.id || "product"}
                height={50}
                width={50}
              />
            )}
          </div>
          <div className="mt-auto py-4 font-medium text-sm">{product.name}</div>
        </div>
      ))}
    </div>
  );
}

If you are using a protected destination, you can pass client credentials to the DestinationClient. Credentials can be generated in the Occtoo Studio.

const destination = new DestinationClient({
  credentials: {
    clientId: "...",
    clientSecret: "...",
  },
});

Then call the authenticate method to authenticate the client:

await destination.authenticate();

Note: Authentication is only permitted server-side. Tokens and credentials should be stored securely and not exposed to unauthorized clients.

If you are calling a protected destination client-side, you can pass an access token directly to the client:

const destination = new DestinationClient({
  headers: {
    Authorization: "Bearer ...",
  }
});

If you are using an unprotected (public) destination, you can skip these steps.

Regenerate the client

If 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:

npx @occtoo/destination-client --generate

Links

• Occtoo docs
• Occtoo website